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.

Sign up for GitHub

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

Jump to bottom

Deprecates uname_attr and uname_info public methods #370

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Deprecates uname_attr and uname_info public methods #370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 60 additions & 5 deletions src/distro/distro.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,9 +546,19 @@ def distro_release_info() -> Dict[str, str]:

def uname_info() -> Dict[str, str]:
"""
.. deprecated:: 1.11.0

:func:`distro.uname_info()` is deprecated and will be removed in a
future version.

Return a dictionary containing key-value pairs for the information items
from the distro release file data source of the current OS distribution.
"""
warnings.warn(
"distro.uname_info() is deprecated and will be removed in a future version.",
DeprecationWarning,
stacklevel=2,
)
return _distro.uname_info()


Expand Down Expand Up @@ -612,6 +622,11 @@ def distro_release_attr(attribute: str) -> str:

def uname_attr(attribute: str) -> str:
"""
.. deprecated:: 1.11.0

:func:`distro.uname_attr()` is deprecated and will be removed in a
future version.

Return a single named information item from the distro release file
data source of the current OS distribution.

Expand All @@ -624,6 +639,11 @@ def uname_attr(attribute: str) -> str:
* (string): Value of the information item, if the item exists.
The empty string, if the item does not exist.
"""
warnings.warn(
"distro.uname_attr() is deprecated and will be removed in a future version.",
DeprecationWarning,
stacklevel=2,
)
return _distro.uname_attr(attribute)


Expand Down Expand Up @@ -853,7 +873,7 @@ def normalize(distro_id: str, table: Dict[str, str]) -> str:
if distro_id:
return normalize(distro_id, NORMALIZED_DISTRO_ID)

distro_id = self.uname_attr("id")
distro_id = self._uname_attr("id")
if distro_id:
return normalize(distro_id, NORMALIZED_DISTRO_ID)

Expand All @@ -869,14 +889,14 @@ def name(self, pretty: bool = False) -> str:
self.os_release_attr("name")
or self.lsb_release_attr("distributor_id")
or self.distro_release_attr("name")
or self.uname_attr("name")
or self._uname_attr("name")
)
if pretty:
name = self.os_release_attr("pretty_name") or self.lsb_release_attr(
"description"
)
if not name:
name = self.distro_release_attr("name") or self.uname_attr("name")
name = self.distro_release_attr("name") or self._uname_attr("name")
version = self.version(pretty=True)
if version:
name = f"{name} {version}"
Expand All @@ -898,9 +918,9 @@ def version(self, pretty: bool = False, best: bool = False) -> str:
self._parse_distro_release_content(
self.lsb_release_attr("description")
).get("version_id", ""),
self.uname_attr("release"),
self._uname_attr("release"),
]
if self.uname_attr("id").startswith("aix"):
if self._uname_attr("id").startswith("aix"):
# On AIX platforms, prefer oslevel command output.
versions.insert(0, self.oslevel_info())
elif self.id() == "debian" or "debian" in self.like().split():
Expand Down Expand Up @@ -1042,11 +1062,24 @@ def distro_release_info(self) -> Dict[str, str]:

def uname_info(self) -> Dict[str, str]:
"""
.. deprecated:: 1.11.0

:func:`LinuxDistribution.uname_info()` is deprecated and will be removed
in a future version.

Return a dictionary containing key-value pairs for the information
items from the uname command data source of the OS distribution.

For details, see :func:`distro.uname_info`.
"""
warnings.warn(
(
"LinuxDistribution.uname_info() is deprecated and will be removed in a"
" future version."
),
DeprecationWarning,
stacklevel=2,
)
return self._uname_info

def oslevel_info(self) -> str:
Expand Down Expand Up @@ -1083,6 +1116,28 @@ def distro_release_attr(self, attribute: str) -> str:
return self._distro_release_info.get(attribute, "")

def uname_attr(self, attribute: str) -> str:
"""
.. deprecated:: 1.11.0

:func:`LinuxDistribution.uname_attr()` is deprecated and will be removed in
a future version.

Return a single named information item from the uname command
output data source of the OS distribution.

For details, see :func:`distro.uname_attr`.
"""
warnings.warn(
(
"LinuxDistribution.uname_attr() is deprecated and will be removed in a"
" future version."
),
DeprecationWarning,
stacklevel=2,
)
return self._uname_attr(attribute)

def _uname_attr(self, attribute: str) -> str:
"""
Return a single named information item from the uname command
output data source of the OS distribution.
Expand Down
18 changes: 9 additions & 9 deletions tests/test_distro.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -779,9 +779,9 @@ def test_dontincludeuname(self) -> None:

self.distro = distro.LinuxDistribution(include_uname=False)

assert self.distro.uname_attr("id") == ""
assert self.distro.uname_attr("name") == ""
assert self.distro.uname_attr("release") == ""
assert self.distro._uname_attr("id") == ""
assert self.distro._uname_attr("name") == ""
assert self.distro._uname_attr("release") == ""

def test_unknowndistro_release(self) -> None:
self._setup_for_distro(os.path.join(TESTDISTROS, "distro", "unknowndistro"))
Expand All @@ -805,17 +805,17 @@ def test_bad_uname(self) -> None:
self._setup_for_distro(os.path.join(TESTDISTROS, "distro", "baduname"))
self.distro = distro.LinuxDistribution()

assert self.distro.uname_attr("id") == ""
assert self.distro.uname_attr("name") == ""
assert self.distro.uname_attr("release") == ""
assert self.distro._uname_attr("id") == ""
assert self.distro._uname_attr("name") == ""
assert self.distro._uname_attr("release") == ""

def test_empty_uname(self) -> None:
self._setup_for_distro(os.path.join(TESTDISTROS, "distro", "emptyuname"))
self.distro = distro.LinuxDistribution()

assert self.distro.uname_attr("id") == ""
assert self.distro.uname_attr("name") == ""
assert self.distro.uname_attr("release") == ""
assert self.distro._uname_attr("id") == ""
assert self.distro._uname_attr("name") == ""
assert self.distro._uname_attr("release") == ""

def test_usrlibosreleaseonly(self) -> None:
self._setup_for_distro(
Expand Down
Loading