separate packages

[svinota]

Version 0.7.x

Packages layout

module name	namespace	requires	conflicts	risks & optional deps
pyroute2	pyroute2, pr2modules		pyroute2.minimal	to be listed
pyroute2.minimal	pyroute2, pr2modules		pyroute2	to be listed

pr2modules

This namespace is provided only for compatibility. A deprecation warning will be raised when used. All the public symbols are provided as before via root pyroute2 exports (entry points).

Version 0.6.x

Starting from version 0.6.1 instead of one monolithic package pyroute2 is broken down into several, minimizing requirements of each package. This should help to:

• prepare minimalistic packages for embedded environments
• exclude from the installation those parts of the project that require not supported on your platform parts of stdlib
• install only those parts that comply with the security requirements on your platform (e.g. no pickle or multiprocessing)

The upgrade process from pre-0.6 should go as usual, the main package pyroute2 requires all the packages. Those who don't care should notice nothing, except of maybe several separate packages pyroute2.xxxx in the pip list output. Others may feel free to install their own sets of packages avoiding unnecessary dependencies and complications.

Packages layout

module name	namespace	requires	conflicts	risks & optional deps
pyroute2.core	pr2modules			ctypes¹, pickle¹
pyroute2.ethtool	pr2modules	pyroute2.core		ctypes
pyroute2.ipdb	pr2modules	pyroute2.core
pyroute2.ipset	pr2modules	pyroute2.core
pyroute2.minimal	pyroute2	pyroute2.core	pyroute2
pyroute2.ndb	pr2modules	pyroute2.core		pyrad², keystoneauth1², keystoneclient², sqlite3, psycopg2², ctypes, pickle
pyroute2.nftables	pr2modules	pyroute2.core
pyroute2.nslink	pr2modules	pyroute2.core		mitogen², pickle,
pyroute2.protocols	pr2modules	pyroute2.core
pyroute2	pyroute2	pyroute2.* except pyroute2.minimal	pyroute2.minimal

¹ to be fixed/(re)moved from the code in 0.7.1
² optional dependency

Review: make audit-imports

Dependencies

pyroute2 and pyroute2-minimal both to provide the pyroute2 namespace but are not namespace packages and are mutually exclusive. The goal of either package is to re-export pyroute2 components from pr2modules to pyroute2 namespace.

pyroute2 package requires the maximal set (and provides all from IPRoute to NetNS and NDB).

pyroute2.minimal package requires the minimal set, and provides only IPRoute, bare netns and some other parts that do not employ any IPC, pickle etc.

Related

• back to single package scheme #935
• dev-python/pyroute2: small version bump .. back to life gentoo/gentoo#25833
• https://bugzilla.redhat.com/show_bug.cgi?id=1953684
• Separate this package into multiple packages and remove all pickle-related functionalities from the main package and allow to use and import without importing any modules that import pickle #785

[dulek]

@svinota: So the idea is that IPDB is gone along with that change? I'm not advocating against it, it was deprecated for a while, yet FYI Kuryr haven't yet migrated to NDB. We'll try to prioritize that.

[svinota]

@dulek I do not plan to ruin everything at once, and I definitely will try not to harm Kuryr.

Let me see, I'll try to provide a patch to Kuryr replacing IPDB with NDB asap.

[dulek]

@svinota: We can always pin pyroute2 version, so it's not that it breaks us when we know in advance. If you could take a look and provide us with advice on migration it would be wonderful, but we'll still need to test NDB for any quirks on our own. Maybe partial patch switching just one driver would be enough to get us going? E.g. bridge: https://github.com/openstack/kuryr-kubernetes/blob/17f99a71782caec0cbf73cb268fc55ef0d2dba06/kuryr_kubernetes/cni/binding/bridge.py#L27

[oseiberts11]

With what do I replace pyroute2.arp ? I have a module that contains, amongst other stuff,

import pyroute2
import pyroute2.arp
...
        self.ip = pyroute2.IPRoute()
...
        for ifl in self.ip.get_links():
            ifl_index = ifl["index"]
            ifl_type = pyroute2.arp.ARPHRD_VALUES.get(ifl["ifi_type"], "UNKNOWN")

and I get an error on importing:

mymodule.py:6: in <module>
    import pyroute2.arp
E   ModuleNotFoundError: No module named 'pyroute2.arp'

Also, it seems that python 3.5 support has been dropped?

[svinota]

Opened a ticket for that: #895