RepoLib

The RepoLib module simplifies working with APT sources, especially those stored in the DEB822 format. It translates these sources into Python Objects for easy reading, parsing, and manipulation of them within Python programs. The program takes a user-defined sources filename and reads the contents, parsing it into a Python object which can then be iterated upon and which uses native data types where practicable. The RepoLib module also allows easy creation of new DEB822-style sources from user-supplied data.

RepoLib

• Source object
  • name
  • enabled
  • types
  • uris
  • suites
  • components
  • options
  • filename
• Methods
  • make_source_string()
  • save_to_disk()
  • load_from_file()
  • set_source_enabled()
• Source() Subclasses
  • SystemSource()
  • DebLine()
  • PPALine()
  • repolib.ppa Module functions
  • SystemSource()
• RepoLib Enums
  • AptSourceType

Example

The following code is a Python prgram that creates an example.sources file in /etc/apt/sources.list.d/ with some sample data, and then modifies the suites used by the source and prints it to the console, before finally saving the new, modified source to disk:

import repolib
source = repolib.Source(
    filename='example.sources',
    name='Example Source', enabled=True, types=['deb', 'deb-src'],
    suites=['disco'], components=['main'],
    options={'Architectures': ['amd64', 'armel']}
)

source.suites.append('cosmic')
source.uris.append('http://example.com/ubuntu')

print(source.make_source_string())

source.save_to_disk()

When run with the appropriate arguments, it prints the contents of the source to console and then saves a new example.sources file in /etc/apt/sources.list.d:

$
Name: Example Source
Enabled: yes
Types: deb deb-src
URIs: http://example.com/ubuntu
Suites: disco cosmic
Components: main
Architectures: amd64 armel
$ ls -la /etc/apt/sources.list.d/example.sources
-rw-r--r-- 1 root root 159 May  1 15:21 /etc/apt/sources.list.d/example.sources

The following will walk you through this example.

Creating a Source Object

The first step in using RepoLib is creating a Source object:

source = repolib.Source(
    filename='example.sources',
    name='Example Source', enabled=True, types=['deb', 'deb-src'],
    suites=['disco'], components=['main'],
    options={'Architectures': ['amd64', 'armel']}
)

The :ref:’source-object’ will hold all of the information about the source we’re working with.

Adding and Manipulating Data

The Source object contains attributes which describe the various parts of the source that are required to fetch and install software. Generally, these attributes are lists of strings which describe the different parts of the source. These attributes can be set or retrieved like any other attributes:

source.suites.append('cosmic')
source.uris.append('http://example.com/ubuntu')

This will add a cosmic suite to our source (which already has a disco suite added), and add a URI from which to fetch software (which wasn’t previously set during object instantiation.

Saving Data to Disk

Once a source has the correct data (either after modification or creation), we need to save it to disk in order for Apt to be made aware of it:

source.save_to_disk()

When called, this writes the data contained within the Source object to disk. This does not destroy the object, so that it may be further manipulated by the program.

Note

While Source object data can be manipulated after using the save_to_disk() method, any subsequent changes will not be automatically written to the disk as well. You need to call save_to_disk() again in order to save further changes.