python-debian 0.1.48__tar.gz → 1.0.0__tar.gz

python-debian-1.0.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.1
+Name: python-debian
+Version: 1.0.0
+Summary: Modules to read and manipulate many file formats related to Debian packages and repositories
+Author-email: Debian python-debian Maintainers <pkg-python-debian-maint@lists.alioth.debian.org>
+License: GPL-2.0-or-later
+Project-URL: homepage, https://salsa.debian.org/python-debian-team/python-debian
+Keywords: debian,linux,metadata,packages,packaging
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Intended Audience :: Developers
+Classifier: License :: DFSG approved
+Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
+Classifier: Operating System :: POSIX
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+Provides-Extra: test
+
+The `debian` Python modules work with Debian-related data formats,
+providing a means to read data from files involved in Debian packaging,
+and the distribution of Debian packages. The ability to create or edit
+the files is also available for some formats.
+
+Currently supported are:
+
+  * Debtags information (`debian.debtags` module)
+  * debian/changelog (`debian.changelog` module)
+  * Packages files, pdiffs (`debian.debian_support` module)
+  * Control files of single or multiple RFC822-style paragraphs, e.g.
+    debian/control, .changes, .dsc, Packages, Sources, Release, etc.
+    (`debian.deb822` module)
+  * Raw .deb and .ar files, with (read-only) access to contained
+    files and meta-information (`debian.debfile` module)
+
+`API documentation`_, can be found online and throughout the code. There
+are examples both within the code and in the examples_ directory.
+
+.. _API documentation: https://python-debian-team.pages.debian.net/python-debian/html/
+
+.. _examples: https://salsa.debian.org/python-debian-team/python-debian/tree/master/examples
+
+Note that some modules can use `python-apt`_ to speed up processing.
+
+.. _python-apt: https://packages.debian.org/unstable/python3-apt
+
+
+Contributions to `python-debian` are most welcome, including expansion of the
+module's capabilities. If you have a module that is for manipulation or
+interrogation of Debian specific data then consider adding it to this package.
+Please discuss your ideas on the `mailing list`_,
+make merge requests via the `salsa repository`_,
+and see the Contributing section of the documentation.
+
+.. _mailing list: mailto:pkg-python-debian-maint@lists.alioth.debian.org
+
+.. _salsa repository: https://salsa.debian.org/python-debian-team/python-debian

{python-debian-0.1.48 → python-debian-1.0.0}/README.rst

@@ -5,14 +5,14 @@ the files is also available for some formats.
 
 Currently supported are:
 
-  * Debtags information (:mod:`debian.debtags` module)
-  * debian/changelog (:mod:`debian.changelog` module)
-  * Packages files, pdiffs (:mod:`debian.debian_support` module)
+  * Debtags information (`debian.debtags` module)
+  * debian/changelog (`debian.changelog` module)
+  * Packages files, pdiffs (`debian.debian_support` module)
   * Control files of single or multiple RFC822-style paragraphs, e.g.
     debian/control, .changes, .dsc, Packages, Sources, Release, etc.
-    (:mod:`debian.deb822` module)
+    (`debian.deb822` module)
   * Raw .deb and .ar files, with (read-only) access to contained
-    files and meta-information (:mod:`debian.debfile` module)
+    files and meta-information (`debian.debfile` module)
 
 `API documentation`_, can be found online and throughout the code. There
 are examples both within the code and in the examples_ directory.
@@ -31,7 +31,7 @@ module's capabilities. If you have a module that is for manipulation or
 interrogation of Debian specific data then consider adding it to this package.
 Please discuss your ideas on the `mailing list`_,
 make merge requests via the `salsa repository`_,
-and see the :ref:`Contributing` section of this documentation.
+and see the Contributing section of the documentation.
 
 .. _mailing list: mailto:pkg-python-debian-maint@lists.alioth.debian.org
 

python-debian-1.0.0/pyproject.toml

@@ -0,0 +1,168 @@
+# https://peps.python.org/pep-0517/
+[build-system]
+requires = [
+    "setuptools>=61",
+    "setuptools_scm[toml]>=6.2",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+# https://peps.python.org/pep-0621/
+[project]
+name = "python-debian"
+dynamic = [
+    "version",
+]
+description = "Modules to read and manipulate many file formats related to Debian packages and repositories"
+readme = "README.rst"
+requires-python = ">=3.7"
+license = { text = "GPL-2.0-or-later" }
+authors = [
+    {name = "Debian python-debian Maintainers", email = "pkg-python-debian-maint@lists.alioth.debian.org"},
+]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Programming Language :: Python",
+  "Intended Audience :: Developers",
+  "License :: DFSG approved",
+  "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
+  "Operating System :: POSIX",
+]
+keywords = ["debian", "linux", "metadata", "packages", "packaging"]
+dependencies = [
+    "charset-normalizer",
+]
+
+[project.urls]
+homepage = "https://salsa.debian.org/python-debian-team/python-debian"
+
+# https://peps.python.org/pep-0621/#dependencies-optional-dependencies
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+]
+
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+[tool.setuptools]
+include-package-data = true
+platforms = [ "any" ]
+# packages = [
+#     "debian",
+#     "debian.tests",
+#     "debian._deb822_repro",
+# ]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = [
+    "debian*",
+]
+exclude = [
+    "debian/tests",
+]
+namespaces = false
+
+[tool.setuptools.package-data]
+"*" = [
+    "py.typed",
+    "*.pyi",
+]
+
+[tool.setuptools_scm]
+write_to = "src/debian/_version.py"
+# needs setuptools_scm > 8
+# version_file = "debian/_version.py"
+
+
+# https://docs.pytest.org/en/6.2.x/customize.html
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = [
+    "--import-mode=prepend",
+    # "--cov-report=term-missing",
+    # "--cov=src/debian",
+    # "--cov=tests",
+    "--doctest-modules",
+    "-v",
+    "-rsx",
+]
+log_level = "DEBUG"
+filterwarnings = [
+]
+testpaths = [
+    "src",
+    "tests",
+]
+pythonpath = "src"
+
+
+# https://coverage.readthedocs.io/en/6.4/config.html
+[tool.coverage.run]
+branch = true
+source = [
+    "src",
+    "tests",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "@overload",
+    "except ImportError",
+    "if __name__ == .__main__.:",
+]
+
+
+
+# https://mypy.readthedocs.io/en/stable/config_file.html
+[tool.mypy]
+files = [
+    "src",
+    "tests",
+]
+strict = true
+show_error_codes = true
+pretty = true
+ignore_missing_imports = true
+warn_unused_ignores = false
+
+
+
+[tool.pylint.main]
+extension-pkg-whitelist = ["apt_pkg"]
+# ignore = ["tests"]
+persistent = false
+
+[tool.pylint."messages control"]
+disable = [
+    "consider-using-f-string",
+    "fixme",
+    "invalid-name",
+    "locally-disabled",
+    "missing-docstring",
+    "protected-access",
+    "raise-missing-from",
+    "super-with-arguments",
+    "too-few-public-methods",
+    "too-many-ancestors",
+    "too-many-boolean-expressions",
+    "too-many-branches",
+    "too-many-instance-attributes",
+    "too-many-arguments",
+    "too-many-lines",
+    "too-many-locals",
+    "too-many-nested-blocks",
+    "too-many-positional-arguments",
+    "too-many-public-methods",
+    "too-many-statements",
+    "unsubscriptable-object",
+    "useless-object-inheritance",
+]
+
+[tool.pylint.reports]
+reports = false
+
+[tool.pylint.similarities]
+min-similarity-lines = 999

python-debian-1.0.0/src/debian/__init__.py

@@ -0,0 +1,23 @@
+""" Tools for working with Debian-related file formats """
+
+__version__ = ""
+
+try:
+    # pylint: disable=no-member
+    import debian._version
+    __version__ = debian._version.__version__
+
+except ImportError:
+    try:
+        from setuptools_scm import get_version
+        __version__ = get_version(root="..")
+    except ImportError:
+        import warnings
+        warnings.warn("_version.py not found and setuptools_scm not installed.")
+    except Exception as e: # pylint: disable=broad-exception-caught
+        import warnings
+        warnings.warn("_version.py not found and setuptools_scm couldn't make a version.\n%s" % e)
+    finally:
+        # Fake a version string in desperation
+        if not __version__:
+            __version__ = '0.0.0-unknown'

{python-debian-0.1.48/lib → python-debian-1.0.0/src}/debian/_arch_table.py

@@ -24,12 +24,8 @@ other people.  Copyright years imported from the sources.
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 import os
-
-try:
-    from typing import Iterable, Optional, IO, List, Dict, Union
-    from os import PathLike
-except ImportError:
-    pass
+from os import PathLike
+from typing import Iterable, Optional, IO, List, Dict, Union
 
 import collections.abc
 
@@ -60,8 +56,7 @@ class QuadTupleDpkgArchitecture(_QuadTuple):
         return super().__contains__(item)
 
     @property
-    def is_wildcard(self):
-        # type: () -> bool
+    def is_wildcard(self) -> bool:
         return any(x == 'any' for x in self)
 
 
@@ -400,6 +395,6 @@ class DpkgArchTable:
             dpkg_arch = self._dpkg_wildcard_to_tuple(wildcard)
         except KeyError:
             return False
-        else:
-            # _dpkg_wildcard_to_tuple falls back to concrete architectures so this can be False
-            return dpkg_arch.is_wildcard
+
+        # _dpkg_wildcard_to_tuple falls back to concrete architectures so this can be False
+        return dpkg_arch.is_wildcard

{python-debian-0.1.48/lib → python-debian-1.0.0/src}/debian/_deb822_repro/__init__.py

@@ -53,7 +53,7 @@ Compared to debian.deb822
 -------------------------
 
 The round-trip safe API is primarily useful when your program is editing files
-and the file in question is (likely) to be hand-edited or formated directly by
+and the file in question is (likely) to be hand-edited or formatted directly by
 human maintainers.  This includes files like debian/control and the
 debian/copyright using the "DEP-5" format.
 
@@ -93,14 +93,14 @@ the round-trip safe API. Given the following source text::
     ...  more deskription with a misspelling
     ... '''.lstrip()  # To remove the leading newline
     >>> # A few definitions to emulate file I/O (would be different in the program)
-    >>> import contextlib
+    >>> import contextlib, os
     >>> @contextlib.contextmanager
     ... def open_input():
     ...     # Works with and without keepends=True.
     ...     # Keep the ends here to truly emulate an open file.
     ...     yield dctrl_input.splitlines(keepends=True)
     >>> def open_output():
-    ...    return open('/dev/null', 'wb')
+    ...    return open(os.devnull, 'wb')
 
 With debian.deb822, your code might look like this::
 
@@ -150,7 +150,7 @@ Deb822ParagraphElement.as_interpreted_dict_view method.
 Stability of this API
 ---------------------
 
-The API is subject to change based on feedback from early adoptors and beta
+The API is subject to change based on feedback from early adopters and beta
 testers.  That said, the code for valid files is unlikely to change in
 a backwards incompatible way.
 

{python-debian-0.1.48/lib → python-debian-1.0.0/src}/debian/_deb822_repro/_util.py

@@ -5,22 +5,17 @@ import sys
 import textwrap
 from abc import ABC
 
-try:
-    from typing import (
-        Optional, Union, Iterable, Callable, TYPE_CHECKING, Iterator,
-        Type, cast, List, Generic,
+from typing import (
+    Optional, Union, Iterable, Callable, TYPE_CHECKING, Iterator,
+    Type, cast, List, Generic,
 )
-    from debian._util import T
-    from debian._deb822_repro.types import TE, R, TokenOrElement
-
-    _combine_parts_ret_type = Callable[
-        [Iterable[Union[TokenOrElement, TE]]],
-        Iterable[Union[TokenOrElement, R]]
-    ]
-except ImportError:
-    TYPE_CHECKING = False
-    cast = lambda t, v: v
+from debian._util import T
+from debian._deb822_repro.types import TE, R, TokenOrElement
 
+_combine_parts_ret_type = Callable[
+    [Iterable[Union[TokenOrElement, TE]]],
+    Iterable[Union[TokenOrElement, R]]
+]
 
 if TYPE_CHECKING:
     from debian._deb822_repro.parsing import Deb822Element
@@ -254,7 +249,7 @@ def len_check_iterator(content,  # type: str
             msg = textwrap.dedent("""\
             Value parser did not fully cover the entire line with tokens (
             missing range {covered}..{content_len}).  Occurred when parsing "{content}"
-            """).format(covered=covered, content_len=content_len, line=content)
+            """).format(covered=covered, content_len=content_len, content=content)
             raise ValueError(msg)
         msg = textwrap.dedent("""\
                     Value parser emitted tokens for more text than was present?  Should have

{python-debian-0.1.48/lib → python-debian-1.0.0/src}/debian/_deb822_repro/formatter.py

@@ -1,7 +1,17 @@
 import operator
+from typing import Iterator, Union
+
+try:
+    from typing_extensions import (
+        Literal,
+    )
+except ImportError:
+    pass
 
 from debian._deb822_repro._util import BufferingIterator
 from debian._deb822_repro.tokens import Deb822Token
+from debian._deb822_repro.types import TokenOrElement, FormatterCallback
+
 
 # Consider these "opaque" enum-like values.  The actual value was chosen to
 # make repr easier to implement, but they are subject to change.
@@ -9,12 +19,6 @@ _CONTENT_TYPE_VALUE = "is_value"
 _CONTENT_TYPE_COMMENT = "is_comment"
 _CONTENT_TYPE_SEPARATOR = "is_separator"
 
-try:
-    from typing import Iterator, Union, Literal
-    from debian._deb822_repro.types import TokenOrElement, FormatterCallback
-except ImportError:
-    pass
-
 
 class FormatterContentToken(object):
     """Typed, tagged text for use with the formatting API
@@ -73,8 +77,7 @@ class FormatterContentToken(object):
         return cls(text, _CONTENT_TYPE_VALUE)
 
     @property
-    def is_comment(self):
-        # type: () -> bool
+    def is_comment(self) -> bool:
         """True if this formatter token represent a comment
 
         This should be used for determining whether the token is a comment
@@ -104,8 +107,7 @@ class FormatterContentToken(object):
         return self._content_type is _CONTENT_TYPE_COMMENT
 
     @property
-    def is_value(self):
-        # type: () -> bool
+    def is_value(self) -> bool:
         """True if this formatter token represents a semantic value
 
         The formatter *MUST* preserve values as-in in its output.  It may
@@ -116,8 +118,7 @@ class FormatterContentToken(object):
         return self._content_type is _CONTENT_TYPE_VALUE
 
     @property
-    def is_separator(self):
-        # type: () -> bool
+    def is_separator(self) -> bool:
         """True if this formatter token represents a separator token
 
         The formatter is not required to preserve the provided separators but it
@@ -133,14 +134,12 @@ class FormatterContentToken(object):
         return self._content_type is _CONTENT_TYPE_SEPARATOR
 
     @property
-    def is_whitespace(self):
-        # type: () -> bool
+    def is_whitespace(self) -> bool:
         """True if this formatter token represents a whitespace token"""
         return self._content_type is _CONTENT_TYPE_SEPARATOR and self._text.isspace()
 
     @property
-    def text(self):
-        # type: () -> str
+    def text(self) -> str:
         """The actual context of the token
 
         This field *must not* be used to determine the type of token.  The
@@ -156,12 +155,10 @@ class FormatterContentToken(object):
         """
         return self._text
 
-    def __str__(self):
-        # type: () -> str
+    def __str__(self) -> str:
         return self._text
 
-    def __repr__(self):
-        # type: () -> str
+    def __repr__(self) -> str:
         return "{}({!r}, {}=True)".format(self.__class__.__name__, self._text, self._content_type)