1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
|
#!/usr/bin/env python3
#
# __init__.py
"""
Utilities for handling packages.
"""
#
# Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
import re
from typing import Dict, Iterable, List
# 3rd party
from dist_meta.metadata_mapping import MetadataMapping
from domdf_python_tools.paths import PathPlus
from domdf_python_tools.typing import PathLike
from packaging.version import InvalidVersion, Version
__all__ = [
"no_dev_versions",
"no_pre_versions",
"normalize",
"normalize_keep_dot",
"read_pyvenv",
]
__author__: str = "Dominic Davis-Foster"
__copyright__: str = "2020 Dominic Davis-Foster"
__license__: str = "MIT License"
__version__: str = "2.2.0"
__email__: str = "dominic@davis-foster.co.uk"
def no_dev_versions(versions: Iterable[str]) -> List[str]:
"""
Returns the subset of ``versions`` which does not end with ``-dev``.
:param versions:
"""
return [v for v in versions if not v.endswith("-dev")]
def no_pre_versions(versions: Iterable[str]) -> List[str]:
"""
Returns the subset of ``versions`` which are not prereleases (alpha, beta, dev, rc etc.).
.. versionadded:: 0.15.0
:param versions:
"""
output = []
for v in versions:
try:
if not Version(v).is_prerelease:
output.append(v)
except InvalidVersion:
output.append(v)
return output
_normalize_pattern = re.compile(r"[-_.]+")
_normalize_keep_dot_pattern = re.compile(r"[-_]+")
def normalize(name: str) -> str:
"""
Normalize the given name for PyPI et al.
From :pep:`503` (public domain).
:param name: The project name.
"""
return _normalize_pattern.sub('-', name).lower()
def normalize_keep_dot(name: str) -> str:
"""
Normalize the given name for PyPI et al., but keep dots in namespace packages.
.. versionadded:: 0.2.1
:param name: The project name.
"""
return _normalize_keep_dot_pattern.sub('-', name).lower()
def read_pyvenv(venv_dir: PathLike) -> Dict[str, str]:
"""
Reads the ``pyvenv.cfg`` for the given virtualenv, and returns a ``key: value`` mapping of its contents.
.. versionadded:: 0.9.0
:param venv_dir:
"""
pyvenv_config: Dict[str, str] = {}
for line in (PathPlus(venv_dir) / "pyvenv.cfg").read_lines():
if line:
key, value, *_ = line.split(" = ")
pyvenv_config[key] = value
return pyvenv_config
class ProjectLinks(MetadataMapping):
pass
|