Fix pypi version detection and rename some attributes (#429)

- Fix outputing sha1 and version in cli
  - Fix outputing version in pypi version detection
  - Rename `GuildAvailableEvent.guild_chunk_nocne` to `GuildAvailableEvent.chunk_nonce`
  - Revert `/documentation`. This will changed back when full version indexing is done

Author: davfsa

hikari/api/rest.py

@@ -780,9 +780,9 @@ def fetch_messages(
             An iterator to fetch the messages.
 
         !!! note
-           This call is not a coroutine function, it returns a special type of
-           lazy iterator that will perform API calls as you iterate across it.
-           See `hikari.iterators` for the full API for this iterator type.
+            This call is not a coroutine function, it returns a special type of
+            lazy iterator that will perform API calls as you iterate across it.
+            See `hikari.iterators` for the full API for this iterator type.
 
         Raises
         ------
@@ -1566,9 +1566,9 @@ def fetch_reactions_for_emoji(
             An iterator to fetch the users.
 
         !!! note
-           This call is not a coroutine function, it returns a special type of
-           lazy iterator that will perform API calls as you iterate across it.
-           See `hikari.iterators` for the full API for this iterator type.
+            This call is not a coroutine function, it returns a special type of
+            lazy iterator that will perform API calls as you iterate across it.
+            See `hikari.iterators` for the full API for this iterator type.
 
         Raises
         ------
@@ -2464,9 +2464,9 @@ def fetch_my_guilds(
             The token's associated guilds.
 
         !!! note
-           This call is not a coroutine function, it returns a special type of
-           lazy iterator that will perform API calls as you iterate across it.
-           See `hikari.iterators` for the full API for this iterator type.
+            This call is not a coroutine function, it returns a special type of
+            lazy iterator that will perform API calls as you iterate across it.
+            See `hikari.iterators` for the full API for this iterator type.
 
         Raises
         ------
@@ -2774,9 +2774,9 @@ def fetch_audit_log(
             The guild's audit log.
 
         !!! note
-           This call is not a coroutine function, it returns a special type of
-           lazy iterator that will perform API calls as you iterate across it.
-           See `hikari.iterators` for the full API for this iterator type.
+            This call is not a coroutine function, it returns a special type of
+            lazy iterator that will perform API calls as you iterate across it.
+            See `hikari.iterators` for the full API for this iterator type.
 
         Raises
         ------
@@ -3763,9 +3763,9 @@ def fetch_members(
             An iterator to fetch the members.
 
         !!! note
-           This call is not a coroutine function, it returns a special type of
-           lazy iterator that will perform API calls as you iterate across it.
-           See `hikari.iterators` for the full API for this iterator type.
+            This call is not a coroutine function, it returns a special type of
+            lazy iterator that will perform API calls as you iterate across it.
+            See `hikari.iterators` for the full API for this iterator type.
 
         Raises
         ------

hikari/cli.py

@@ -37,12 +37,12 @@ def main() -> None:
     sourcefile = inspect.getsourcefile(_about)
     assert isinstance(sourcefile, str)
     path: typing.Final[str] = os.path.abspath(os.path.dirname(sourcefile))
-    sha1: typing.Final[str] = _about.__git_sha1__
+    sha1: typing.Final[str] = _about.__git_sha1__[:8]
     version: typing.Final[str] = _about.__version__
     py_impl: typing.Final[str] = platform.python_implementation()
     py_ver: typing.Final[str] = platform.python_version()
     py_compiler: typing.Final[str] = platform.python_compiler()
-    sys.stderr.write(f"hikari v{version} {sha1}\n")
+    sys.stderr.write(f"hikari ({version}) [{sha1}]\n")
     sys.stderr.write(f"located at {path}\n")
     sys.stderr.write(f"{py_impl} {py_ver} {py_compiler}\n")
     sys.stderr.write(" ".join(frag.strip() for frag in platform.uname() if frag and frag.strip()) + "\n")

hikari/events/guild_events.py

@@ -214,8 +214,8 @@ class GuildAvailableEvent(GuildVisibilityEvent):
         The voice states active in the guild.
     """
 
-    guild_chunk_nonce: typing.Optional[str] = attr.ib(repr=False, default=None)
-    """Nonce used to request the guild chunks.
+    chunk_nonce: typing.Optional[str] = attr.ib(repr=False, default=None)
+    """Nonce used to request the member chunks for this guild.
 
     This will be `builtins.None` if no chunks were requested.
 
@@ -225,7 +225,7 @@ class GuildAvailableEvent(GuildVisibilityEvent):
     Returns
     -------
     typing.Optional[builtins.str]
-        The nonce used to request the guild chunks.
+        The nonce used to request the member chunks.
     """
 
     @property

hikari/impl/event_manager.py

@@ -149,7 +149,7 @@ async def on_guild_create(self, shard: gateway_shard.GatewayShard, payload: data
         if members_declared and (event.guild.is_large or not presences_declared):
             # We create a task here instead of awaiting the result to avoid any rate-limits from delaying dispatch.
             nonce = f"{shard.id}.{time.uuid()}"
-            event.guild_chunk_nonce = nonce
+            event.chunk_nonce = nonce
             coroutine = shard.request_guild_members(
                 event.guild, include_presences=bool(presences_declared), nonce=nonce
             )

hikari/internal/ux.py

@@ -275,6 +275,14 @@ def parse(self, vstring: str) -> None:  # type: ignore[override]
         else:
             self.prerelease = None
 
+    def __str__(self) -> str:
+        vstring = ".".join(map(str, self.version))
+
+        if self.prerelease:
+            vstring = vstring + self.prerelease[0] + str(self.prerelease[1])
+
+        return vstring
+
 
 async def check_for_updates(http_settings: config.HTTPSettings, proxy_settings: config.ProxySettings) -> None:
     """Perform a check for newer versions of the library, logging any found."""

pipelines/pages.nox.py

@@ -74,10 +74,10 @@ def pages(session: nox.Session) -> None:
     )
 
     # Rename `hikari` into `documentation`
-    print("Renaming output dir...")
-    print(f"{config.ARTIFACT_DIRECTORY}/{config.MAIN_PACKAGE} -> {config.ARTIFACT_DIRECTORY}/documentation")
-    shutil.rmtree(f"{config.ARTIFACT_DIRECTORY}/documentation", ignore_errors=True)
-    shutil.move(f"{config.ARTIFACT_DIRECTORY}/{config.MAIN_PACKAGE}", f"{config.ARTIFACT_DIRECTORY}/documentation")
+    # print("Renaming output dir...")
+    # print(f"{config.ARTIFACT_DIRECTORY}/{config.MAIN_PACKAGE} -> {config.ARTIFACT_DIRECTORY}/documentation")
+    # shutil.rmtree(f"{config.ARTIFACT_DIRECTORY}/documentation", ignore_errors=True)
+    # shutil.move(f"{config.ARTIFACT_DIRECTORY}/{config.MAIN_PACKAGE}", f"{config.ARTIFACT_DIRECTORY}/documentation")
 
     # Pre-generated indexes
     if shutil.which("npm") is None:

tests/hikari/impl/test_event_manager.py

@@ -156,15 +156,15 @@ async def test_on_guild_create(self, event_manager, shard, app):
             members={"TestMember": 5678},
             presences={"TestPresence": 9012},
             voice_states={"TestState": 345},
-            guild_chunk_nonce=None,
+            chunk_nonce=None,
         )
 
         event_manager._app.event_factory.deserialize_guild_create_event.return_value = event
         shard.request_guild_members = mock.AsyncMock()
 
         await event_manager.on_guild_create(shard, payload)
 
-        assert event.guild_chunk_nonce is None
+        assert event.chunk_nonce is None
         shard.request_guild_members.assert_not_called()
 
         event_manager._cache.update_guild.assert_called_once_with(event.guild)
@@ -201,7 +201,7 @@ async def test_on_guild_create_when_request_chunks(self, event_manager, shard, a
             members={"TestMember": 5678},
             presences={"TestPresence": 9012},
             voice_states={"TestState": 345},
-            guild_chunk_nonce=None,
+            chunk_nonce=None,
         )
 
         event_manager._app.event_factory.deserialize_guild_create_event.return_value = event
@@ -213,7 +213,7 @@ async def test_on_guild_create_when_request_chunks(self, event_manager, shard, a
 
         uuid.assert_called_once_with()
         nonce = "987.uuid"
-        assert event.guild_chunk_nonce == nonce
+        assert event.chunk_nonce == nonce
         shard.request_guild_members.assert_called_once_with(event.guild, include_presences=True, nonce=nonce)
         create_task.assert_called_once_with(shard.request_guild_members(), name="987:123 guild create members request")