Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add distutils/version.py to azurelinuxagent #3063

Merged
merged 5 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion azurelinuxagent/common/future.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,23 @@
range = xrange
int = long


if sys.version_info[1] >= 7:
from collections import OrderedDict # For Py 2.7+
else:
from ordereddict import OrderedDict # Works only on 2.6 # pylint: disable=E0401
else:
raise ImportError("Unknown python version: {0}".format(sys.version_info))

#
# distutils has been removed from Python >= 3.12; use the copy from azurelinuxagent instead
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it's same copy, why don't we use it for all py versions? or eventually we remove distutils dependency when things work with copy?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version.py is not identical across python versions; mostly syntactic differences, but i do not want to take the risk of introducing any changes in behavior across existing distros/python versions, so I am using the copy only on distros/python where there isn't a version.py

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(LooseVersion is used in the osutil hierarchy in many places, and that code is poorly tested)

#
if sys.version_info[0] == 3 and sys.version_info[1] >= 12:
from azurelinuxagent.distutils import version
else:
from distutils import version # pylint: disable=deprecated-module
Version = version.Version
LooseVersion = version.LooseVersion


def get_linux_distribution(get_full_name, supported_dists):
"""Abstract platform.linux_distribution() call which is deprecated as of
Expand Down
2 changes: 1 addition & 1 deletion azurelinuxagent/common/osutil/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
#


from distutils.version import LooseVersion as Version # pylint: disable=no-name-in-module, import-error, disable=deprecated-module
from azurelinuxagent.common.future import LooseVersion as Version

import azurelinuxagent.common.logger as logger
from azurelinuxagent.common.version import DISTRO_NAME, DISTRO_CODE_NAME, DISTRO_VERSION, DISTRO_FULL_NAME
Expand Down
6 changes: 3 additions & 3 deletions azurelinuxagent/common/utils/flexible_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
# Requires Python 2.6+ and Openssl 1.0+
#

from distutils import version # pylint: disable=no-name-in-module, disable=deprecated-module
from azurelinuxagent.common.future import Version
import re


class FlexibleVersion(version.Version):
class FlexibleVersion(Version):
"""
A more flexible implementation of distutils.version.StrictVersion

Expand All @@ -41,7 +41,7 @@ class FlexibleVersion(version.Version):
"""

def __init__(self, vstring=None, sep='.', prerel_tags=('alpha', 'beta', 'rc')):
version.Version.__init__(self)
Version.__init__(self)

if sep is None:
sep = '.'
Expand Down
Empty file.
236 changes: 236 additions & 0 deletions azurelinuxagent/distutils/version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,236 @@
#
# A copy of distutils/version.py as Python 3.8 (minus the StrictVersion class)
#
# Implements multiple version numbering conventions for the
# Python Module Distribution Utilities.
#
# $Id$
#

"""Provides classes to represent module version numbers (one class for
each style of version numbering). There are currently two such classes
implemented: StrictVersion and LooseVersion.

Every version number class implements the following interface:
* the 'parse' method takes a string and parses it to some internal
representation; if the string is an invalid version number,
'parse' raises a ValueError exception
* the class constructor takes an optional string argument which,
if supplied, is passed to 'parse'
* __str__ reconstructs the string that was passed to 'parse' (or
an equivalent string -- ie. one that will generate an equivalent
version number instance)
* __repr__ generates Python code to recreate the version number instance
* _cmp compares the current instance with either another instance
of the same class or a string (which will be parsed to an instance
of the same class, thus must follow the same rules)
"""

import re

# E1101: Instance of 'Version' has no '_cmp' member (no-member)
# pylint: disable=no-member


class Version:
"""Abstract base class for version numbering classes. Just provides
constructor (__init__) and reproducer (__repr__), because those
seem to be the same for all version numbering classes; and route
rich comparisons to _cmp.
"""

def __init__(self, vstring=None):
if vstring:
self.parse(vstring)

def __repr__(self):
return "%s ('%s')" % (self.__class__.__name__, str(self))

def __eq__(self, other):
c = self._cmp(other)
if c is NotImplemented:
return c
return c == 0

def __lt__(self, other):
c = self._cmp(other)
if c is NotImplemented:
return c
return c < 0

def __le__(self, other):
c = self._cmp(other)
if c is NotImplemented:
return c
return c <= 0

def __gt__(self, other):
c = self._cmp(other)
if c is NotImplemented:
return c
return c > 0

def __ge__(self, other):
c = self._cmp(other)
if c is NotImplemented:
return c
return c >= 0


# Interface for version-number classes -- must be implemented
# by the following classes (the concrete ones -- Version should
# be treated as an abstract class).
# __init__ (string) - create and take same action as 'parse'
# (string parameter is optional)
# parse (string) - convert a string representation to whatever
# internal representation is appropriate for
# this style of version numbering
# __str__ (self) - convert back to a string; should be very similar
# (if not identical to) the string supplied to parse
# __repr__ (self) - generate Python code to recreate
# the instance
# _cmp (self, other) - compare two version numbers ('other' may
# be an unparsed version string, or another
# instance of your version class)


# The rules according to Greg Stein:
# 1) a version number has 1 or more numbers separated by a period or by
# sequences of letters. If only periods, then these are compared
# left-to-right to determine an ordering.
# 2) sequences of letters are part of the tuple for comparison and are
# compared lexicographically
# 3) recognize the numeric components may have leading zeroes
#
# The LooseVersion class below implements these rules: a version number
# string is split up into a tuple of integer and string components, and
# comparison is a simple tuple comparison. This means that version
# numbers behave in a predictable and obvious way, but a way that might
# not necessarily be how people *want* version numbers to behave. There
# wouldn't be a problem if people could stick to purely numeric version
# numbers: just split on period and compare the numbers as tuples.
# However, people insist on putting letters into their version numbers;
# the most common purpose seems to be:
# - indicating a "pre-release" version
# ('alpha', 'beta', 'a', 'b', 'pre', 'p')
# - indicating a post-release patch ('p', 'pl', 'patch')
# but of course this can't cover all version number schemes, and there's
# no way to know what a programmer means without asking him.
#
# The problem is what to do with letters (and other non-numeric
# characters) in a version number. The current implementation does the
# obvious and predictable thing: keep them as strings and compare
# lexically within a tuple comparison. This has the desired effect if
# an appended letter sequence implies something "post-release":
# eg. "0.99" < "0.99pl14" < "1.0", and "5.001" < "5.001m" < "5.002".
#
# However, if letters in a version number imply a pre-release version,
# the "obvious" thing isn't correct. Eg. you would expect that
# "1.5.1" < "1.5.2a2" < "1.5.2", but under the tuple/lexical comparison
# implemented here, this just isn't so.
#
# Two possible solutions come to mind. The first is to tie the
# comparison algorithm to a particular set of semantic rules, as has
# been done in the StrictVersion class above. This works great as long
# as everyone can go along with bondage and discipline. Hopefully a
# (large) subset of Python module programmers will agree that the
# particular flavour of bondage and discipline provided by StrictVersion
# provides enough benefit to be worth using, and will submit their
# version numbering scheme to its domination. The free-thinking
# anarchists in the lot will never give in, though, and something needs
# to be done to accommodate them.
#
# Perhaps a "moderately strict" version class could be implemented that
# lets almost anything slide (syntactically), and makes some heuristic
# assumptions about non-digits in version number strings. This could
# sink into special-case-hell, though; if I was as talented and
# idiosyncratic as Larry Wall, I'd go ahead and implement a class that
# somehow knows that "1.2.1" < "1.2.2a2" < "1.2.2" < "1.2.2pl3", and is
# just as happy dealing with things like "2g6" and "1.13++". I don't
# think I'm smart enough to do it right though.
#
# In any case, I've coded the test suite for this module (see
# ../test/test_version.py) specifically to fail on things like comparing
# "1.2a2" and "1.2". That's not because the *code* is doing anything
# wrong, it's because the simple, obvious design doesn't match my
# complicated, hairy expectations for real-world version numbers. It
# would be a snap to fix the test suite to say, "Yep, LooseVersion does
# the Right Thing" (ie. the code matches the conception). But I'd rather
# have a conception that matches common notions about version numbers.

# W0231: __init__ method from base class 'Version' is not called (super-init-not-called)
# R1710: Either all return statements in a function should return an expression, or none of them should. (inconsistent-return-statements)
# pylint: disable=super-init-not-called, inconsistent-return-statements

class LooseVersion (Version):

"""Version numbering for anarchists and software realists.
Implements the standard interface for version number classes as
described above. A version number consists of a series of numbers,
separated by either periods or strings of letters. When comparing
version numbers, the numeric components will be compared
numerically, and the alphabetic components lexically. The following
are all valid version numbers, in no particular order:

1.5.1
1.5.2b2
161
3.10a
8.02
3.4j
1996.07.12
3.2.pl0
3.1.1.6
2g6
11g
0.960923
2.2beta29
1.13++
5.5.kw
2.0b1pl0

In fact, there is no such thing as an invalid version number under
this scheme; the rules for comparison are simple and predictable,
but may not always give the results you want (for some definition
of "want").
"""

component_re = re.compile(r'(\d+|[a-z]+|\.)', re.VERBOSE)

def __init__(self, vstring=None):
if vstring:
self.parse(vstring)

def parse(self, vstring):
# I've given up on thinking I can reconstruct the version string
# from the parsed tuple -- so I just store the string here for
# use by __str__
self.vstring = vstring
components = [x for x in self.component_re.split(vstring) if x and x != '.']
for i, obj in enumerate(components):
try:
components[i] = int(obj)
except ValueError:
pass

self.version = components

def __str__(self):
return self.vstring

def __repr__(self):
return "LooseVersion ('%s')" % str(self)

def _cmp(self, other):
if isinstance(other, str):
other = LooseVersion(other)

if self.version == other.version:
return 0
if self.version < other.version:
return -1
if self.version > other.version:
return 1


# end class LooseVersion
4 changes: 2 additions & 2 deletions azurelinuxagent/ga/exthandlers.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import tempfile
import time
import zipfile
from distutils.version import LooseVersion # pylint: disable=deprecated-module
from azurelinuxagent.common.future import LooseVersion as Version
from collections import defaultdict
from functools import partial

Expand Down Expand Up @@ -2250,7 +2250,7 @@ def get_resource_limits(self, extension_name, str_version):
This is not effective after nov 30th.
"""
if ExtHandlerInstance.is_azuremonitorlinuxagent(extension_name):
if LooseVersion(str_version) < LooseVersion("1.12"):
if Version(str_version) < Version("1.12"):
test_man = {
"resourceLimits": {
"services": [
Expand Down
2 changes: 1 addition & 1 deletion azurelinuxagent/pa/deprovision/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# Requires Python 2.6+ and Openssl 1.0+
#

from distutils.version import LooseVersion as Version # pylint: disable=no-name-in-module, import-error, deprecated-module
from azurelinuxagent.common.future import LooseVersion as Version

from azurelinuxagent.common.version import DISTRO_NAME, DISTRO_VERSION, DISTRO_FULL_NAME
from .arch import ArchDeprovisionHandler
Expand Down
2 changes: 1 addition & 1 deletion azurelinuxagent/pa/rdma/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
# Requires Python 2.6+ and Openssl 1.0+
#

from distutils.version import LooseVersion as Version # pylint: disable=no-name-in-module, import-error, deprecated-module
from azurelinuxagent.common.future import LooseVersion as Version
import azurelinuxagent.common.logger as logger
from azurelinuxagent.pa.rdma.rdma import RDMAHandler
from azurelinuxagent.common.version import DISTRO_FULL_NAME, DISTRO_VERSION
Expand Down
2 changes: 1 addition & 1 deletion azurelinuxagent/pa/rdma/suse.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
from azurelinuxagent.pa.rdma.rdma import RDMAHandler
from azurelinuxagent.common.version import DISTRO_VERSION

from distutils.version import LooseVersion as Version # pylint: disable=deprecated-module
from azurelinuxagent.common.future import LooseVersion as Version


class SUSERDMAHandler(RDMAHandler):
Expand Down
2 changes: 1 addition & 1 deletion tests/common/utils/test_flexible_version.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import random # pylint: disable=unused-import
import re
import unittest

from azurelinuxagent.common.utils.flexible_version import FlexibleVersion


class TestFlexibleVersion(unittest.TestCase):

def setUp(self):
Expand Down
2 changes: 1 addition & 1 deletion tests/common/utils/test_text_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import hashlib
import os
import unittest
from distutils.version import LooseVersion as Version # pylint: disable=no-name-in-module,import-error
from azurelinuxagent.common.future import LooseVersion as Version

import azurelinuxagent.common.utils.textutil as textutil
from azurelinuxagent.common.future import ustr
Expand Down
Loading