Skip to content

Commit

Permalink
Added tests for utilities.ux
Browse files Browse the repository at this point in the history
  - Fix issues detecting and outputing new version from PyPI
  • Loading branch information
davfsa committed Sep 16, 2020
1 parent 81196ac commit 63b3c30
Show file tree
Hide file tree
Showing 5 changed files with 490 additions and 28 deletions.
4 changes: 2 additions & 2 deletions hikari/api/rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -1915,7 +1915,7 @@ async def add_user_to_guild(
guild : hikari.snowflakes.SnowflakeishOr[hikari.guilds.PartialGuild]
The guild to add the user to. This can be a `hikari.guilds.PartialGuild`
or the ID of an existing guild.
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialGuild]
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The user to add to the guild. This can be a `hikari.users.PartialUser`
or the ID of an existing user.
nick : hikari.undefined.UndefinedOr[builtins.str]
Expand Down Expand Up @@ -1984,7 +1984,7 @@ async def fetch_user(self, user: snowflakes.SnowflakeishOr[users.PartialUser]) -
Parameters
----------
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialGuild]
user : hikari.snowflakes.SnowflakeishOr[hikari.users.PartialUser]
The user to fetch. This can be a `hikari.users.PartialUser`
or the ID of an existing user.
Expand Down
2 changes: 1 addition & 1 deletion hikari/presences.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ class ActivityType(enum.IntEnum):
"""

COMPETING = 5
"""Shows up as `Competing in <name>`"""
"""Shows up as `Competing in <name>`."""

def __str__(self) -> str:
return self.name
Expand Down
67 changes: 43 additions & 24 deletions hikari/utilities/ux.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@

__all__: typing.List[str] = ["init_logging", "print_banner", "supports_color", "HikariVersion", "check_for_updates"]

import contextlib
import distutils.version
import importlib.resources
import logging.config
Expand Down Expand Up @@ -140,6 +139,9 @@ def print_banner(package: typing.Optional[str], allow_color: bool, force_color:
package : typing.Optional[builtins.str]
The package to find the `banner.txt` in, or `builtins.None` if no
banner should be shown.
!!! note
The `banner.txt` must be in the root folder of the package.
allow_color : builtins.bool
If `builtins.False`, no colour is allowed. If `builtins.True`, the
output device must be supported for this to return `builtins.True`.
Expand Down Expand Up @@ -173,9 +175,6 @@ def print_banner(package: typing.Optional[str], allow_color: bool, force_color:
# Python stuff.
"python_implementation": platform.python_implementation(),
"python_version": platform.python_version(),
"python_build": " ".join(platform.python_build()),
"python_branch": platform.python_branch(),
"python_compiler": platform.python_compiler(),
# Platform specific stuff I might remove later.
"system_description": " ".join(filtered_system_bits),
}
Expand All @@ -190,30 +189,33 @@ def print_banner(package: typing.Optional[str], allow_color: bool, force_color:


def supports_color(allow_color: bool, force_color: bool) -> bool:
"""Return `builtins.True` if the terminal device supports colour output.
"""Return `builtins.True` if the terminal device supports color output.
Parameters
----------
allow_color : builtins.bool
If `builtins.False`, no colour is allowed. If `builtins.True`, the
If `builtins.False`, no color is allowed. If `builtins.True`, the
output device must be supported for this to return `builtins.True`.
force_color : builtins.bool
If `builtins.True`, return `builtins.True` always, otherwise only
return `builtins.True` if the device supports colour output and the
return `builtins.True` if the device supports color output and the
`allow_color` flag is not `builtins.False`.
Returns
-------
builtins.bool
`builtins.True` if colour is allowed on the output terminal, or
`builtins.True` if color is allowed on the output terminal, or
`builtins.False` otherwise.
"""
if not allow_color:
return False

# isatty is not always implemented, https://code.djangoproject.com/ticket/6223
is_a_tty = hasattr(sys.stdout, "isatty") and sys.stdout.isatty()

if os.getenv("CLICOLOR_FORCE", "0") != "0" or force_color:
return True
elif (os.getenv("CLICOLOR", "0") != "0" or allow_color) and is_a_tty:
elif os.getenv("CLICOLOR", "0") != "0" and is_a_tty:
return True

plat = sys.platform
Expand All @@ -237,12 +239,33 @@ class HikariVersion(distutils.version.StrictVersion):

# Not typed correctly on distutils, so overriding it raises a false positive...
version_re: typing.ClassVar[typing.Final[re.Pattern[str]]] = re.compile( # type: ignore[misc]
r"^(\d+)\.(\d+)(\.(\d+))?(\.[a-z]+(\d+))?$", re.I
r"^(\d+)\.(\d+)(\.(\d+))?(\.[a-z]+)?(\d+)?$", re.I
)

# Parse doesnt set the prerelease correctly, so we overwrite it to fix it.
#
# Not typed correctly on distutils, so overriding it raises a false positive...
def parse(self, vstring: str) -> None: # type: ignore[override]
match = self.version_re.match(vstring)
if not match:
raise ValueError(f"invalid version number '{vstring}'")

(major, minor, patch, prerelease, prerelease_num) = match.group(1, 2, 4, 5, 6)

self.version = (int(major), int(minor), int(patch) if patch else 0)

if prerelease:
self.prerelease = (prerelease, int(prerelease_num))
else:
self.prerelease = None


async def check_for_updates() -> None:
"""Perform a check for newer versions of the library, logging any found."""
if about.__git_sha1__.casefold() == "head":
# We are not in a PyPI release, return
return

try:
async with aiohttp.request(
"GET", "https://pypi.org/pypi/hikari/json", timeout=aiohttp.ClientTimeout(total=1.5), raise_for_status=True
Expand All @@ -251,24 +274,20 @@ async def check_for_updates() -> None:

this_version = HikariVersion(about.__version__)
is_dev = this_version.prerelease is not None
is_ambiguous_dev = about.__git_sha1__.casefold() == "head"
newer_releases: typing.List[HikariVersion] = []

for release_string, artifacts in data["releases"].items():
if not all(artifact["yanked"] for artifact in artifacts):
with contextlib.suppress(Exception):
v = HikariVersion(release_string)
if v.prerelease is not None and not is_dev:
# Don't encourage the user to upgrade from a stable to a dev release...
continue

if is_dev and is_ambiguous_dev and v.version == this_version.version:
# i.e. we are a git release of v2.0.0.dev, and we compare to pypi
# 2.0.0.dev67, we cannot determine if we are newer or not...
continue

if v > this_version:
newer_releases.append(v)
v = HikariVersion(release_string)
if v.prerelease is not None and not is_dev:
# Don't encourage the user to upgrade from a stable to a dev release...
continue

if v.version == this_version.version:
continue

if v > this_version:
newer_releases.append(v)
if newer_releases:
newest = max(newer_releases)
_LOGGER.info("A newer version of hikari is available, consider upgrading to %s", newest)
Expand Down
3 changes: 2 additions & 1 deletion tests/hikari/impl/test_shard.py
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,8 @@ async def test__identify_when_no_intents(self, client):
stack.enter_context(mock.patch.object(aiohttp, "__version__", new="v0.0.1"))
stack.enter_context(mock.patch.object(_about, "__version__", new="v1.0.0"))

await client._identify()
with stack:
await client._identify()

expected_json = {
"op": 2,
Expand Down
Loading

0 comments on commit 63b3c30

Please sign in to comment.