Merge branch 'master' into feature/entitlements

hikari-py · Apr 15, 2024 · 91f9008 · 91f9008
2 parents fec3422 + 9a7d58a
commit 91f9008
Show file tree

Hide file tree

Showing 182 changed files with 4,414 additions and 4,362 deletions.
diff --git a/.flake8 b/.flake8
@@ -3,6 +3,7 @@ count = true
 
 # A002:  Argument is shadowing a python builtin.
 # A003: Class attribute is shadowing a python builtin.
+# A005: Module is shadowing a python builtin module.
 # CFQ002: Function has too many arguments.
 # CFQ004: Function has too many returns.
 # D102: Missing docstring in public method.
@@ -17,6 +18,7 @@ count = true
 ignore =
     A002,
     A003,
+    A005,
     CFQ002,
     CFQ004,
     D102,

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -191,15 +191,13 @@ jobs:
       - name: Setup python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
-
-      - name: Setup node
-        uses: actions/setup-node@v4
+          # NOTE: This should be kept up to date with .readthedocs.yaml
+          python-version: 3.11
 
       - name: Build documentation
         run: |
           pip install -r dev-requirements.txt
-          nox -s sphinx
+          nox -s mkdocs
 
       - name: Upload artifacts
         if: github.event_name == 'pull_request'

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,26 +3,14 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    # NOTE: This should be kept up to date with .ci.yml
+    python: "3.11"
 
-sphinx:
-  configuration: docs/conf.py
-  builder: dirhtml
+mkdocs:
+  configuration: mkdocs.yml
 
 python:
    install:
-     - requirements: dev-requirements/sphinx.txt
+     - requirements: dev-requirements/mkdocs.txt
      - method: pip
        path: .
-
-search:
-  ignore:
-    # Defaults
-    - search.html
-    - search/index.html
-    - 404.html
-    - 404/index.html
-
-    # Custom
-    - index.html
-    - changelog/index.html
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,44 @@
+## 2.0.0.dev124 (2024-04-07)
+
+### Features
+
+- Improve `Emoji.parse` typing to make it more explicit ([#1870](https://github.com/hikari-py/hikari/issues/1870))
+- Add ability to edit own user banner ([#1871](https://github.com/hikari-py/hikari/issues/1871))
+
+### Bugfixes
+
+- Fix incorrectly formatted error strings ([#1866](https://github.com/hikari-py/hikari/issues/1866))
+- Properly handle initial opcode as being RECONNECT (7) ([#1867](https://github.com/hikari-py/hikari/issues/1867))
+
+### Documentation Improvements
+
+- Replace mentions of `PRIVATE_MESSAGES` with `DM_MESSAGES` ([#1874](https://github.com/hikari-py/hikari/issues/1874))
+
+---
+## 2.0.0.dev123 (2024-03-31)
+
+### Breaking Changes
+
+- Remove previously deprecated `Permissions.MANAGE_EMOJIS_AND_STICKERS` ([#1762](https://github.com/hikari-py/hikari/issues/1762))
+
+### Features
+
+- Allow subscribing to generic events ([#1814](https://github.com/hikari-py/hikari/issues/1814))
+- Allow changing guild features (community, etc.) ([#1828](https://github.com/hikari-py/hikari/issues/1828))
+- Improve embed parameters typing ([#1841](https://github.com/hikari-py/hikari/issues/1841))
+
+### Bugfixes
+
+- Fix `CommandInteractionOption.value` typehint not including `float` ([#1805](https://github.com/hikari-py/hikari/issues/1805))
+- `Member.joined_at` is now nullable due to breaking API change
+   - This will be received on guest members with temporary membership ([#1812](https://github.com/hikari-py/hikari/issues/1812))
+- Shard rate-limiters are now reset per websocket connection, avoiding a rare issue where a persistent network issue could allow the shard to be rate-limited ([#1813](https://github.com/hikari-py/hikari/issues/1813))
+
+### Documentation Improvements
+
+- Switch documentation to mkdocs ([#1810](https://github.com/hikari-py/hikari/issues/1810))
+
+---
 ## 2.0.0.dev122 (2023-11-18)
 
 ### Deprecation

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -41,7 +41,7 @@ Possible types are:
 
 - `feature`: Signifying a new feature.
 - `bugfix`: Signifying a bugfix.
-- `doc`: Signifying a documentation improvement.
+- `documentation`: Signifying a documentation improvement.
 - `removal`: Signifying a deprecation or removal of public API.
 
 For changes that do not fall under any of the above cases, please specify the lack of the changelog in the pull request

diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Python 3.8, 3.9, 3.10, 3.11 and 3.12 are currently supported.
 
 ## Installation
 
-Install Hikari from PyPI with the following command:
+Install hikari from PyPI with the following command:
 
 ```bash
 python -m pip install -U hikari
@@ -35,6 +35,7 @@ py -3 -m pip install -U hikari
 ## Bots
 
 Hikari provides two different default bot implementations to suit your needs:
+
 - [GatewayBot](#gatewaybot)
 - [RESTBot](#restbot)
 
@@ -194,6 +195,7 @@ bot.run(
 
 Many other helpful options exist for you to take advantage of if you wish. Links to the respective docs can be seen
 below:
+
 - [GatewayBot.run](https://docs.hikari-py.dev/en/stable/reference/hikari/impl/gateway_bot/#hikari.impl.gateway_bot.GatewayBot.run)
 - [RESTBot.run](https://docs.hikari-py.dev/en/stable/reference/hikari/impl/rest_bot/#hikari.impl.rest_bot.RESTBot.run)
 
@@ -246,14 +248,20 @@ python -m pip install -U hikari[speedups, server]
 
 ## Additional resources
 
-You may wish to use a command framework on top of Hikari so that you can start writing a bot quickly without
+You may wish to use a command framework on top of hikari so that you can start writing a bot quickly without
 implementing your own command handler.
 
 Hikari does not include a command framework by default, so you will want to pick a third party library to do it:
 
-- [`lightbulb`](https://github.com/tandemdude/hikari-lightbulb) - a simple and easy to use command framework for Hikari.
-- [`tanjun`](https://github.com/FasterSpeeding/Tanjun) - a flexible command framework designed to extend Hikari.
-- [`crescent`](https://github.com/magpie-dev/hikari-crescent) - a command handler for Hikari that keeps your project neat and tidy.
+- [`arc`](https://github.com/hypergonial/hikari-arc) - a bot framework with a focus on type-safety and correctness.
+- [`crescent`](https://github.com/magpie-dev/hikari-crescent) - a command handler for hikari that keeps your project neat and tidy.
+- [`lightbulb`](https://github.com/tandemdude/hikari-lightbulb) - a simple and easy to use command framework for hikari.
+- [`tanjun`](https://github.com/FasterSpeeding/Tanjun) - a flexible command framework designed to extend hikari.
+
+There are also third party libraries to help you manage components:
+
+- [`miru`](https://github.com/hypergonial/hikari-miru) - A component handler for hikari, inspired by discord.py's views.
+- [`flare`](https://github.com/brazier-dev/hikari-flare/) - a component manager designed to write simple interactions with persistent data.
 
 ---
 
@@ -307,7 +315,7 @@ Currently, this functionality does not yet exist.
 
 ---
 
-## Developing Hikari
+## Developing hikari
 
 To familiarize yourself a bit with the project, we recommend reading our
 [contributing manual](https://github.com/hikari-py/hikari/blob/master/CONTRIBUTING.md).

diff --git a/changes/1762.breaking.md b/changes/1762.breaking.md
diff --git a/changes/1805.bugfix.md b/changes/1805.bugfix.md
diff --git a/changes/1812.bugfix.md b/changes/1812.bugfix.md
diff --git a/changes/1813.bugfix.md b/changes/1813.bugfix.md
diff --git a/changes/1814.feature.md b/changes/1814.feature.md
diff --git a/changes/1877.feature.md b/changes/1877.feature.md
@@ -0,0 +1,2 @@
+- Add `message_link` property to `MessageReference`
+- Add `channel_link` property to `MessageReference`
diff --git a/changes/1881.bugfix.md b/changes/1881.bugfix.md
@@ -0,0 +1 @@
+Fix warning raised in aiohttp 3.9.4 when using `FormData` (most commonly, when uploading attachments)
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1 +1 @@
-nox==2023.4.22
+nox==2024.3.2
diff --git a/dev-requirements/build.txt b/dev-requirements/build.txt
@@ -1,2 +1,2 @@
 setuptools>=65.2.0
-wheel==0.42.0
+wheel==0.43.0
diff --git a/dev-requirements/coverage.txt b/dev-requirements/coverage.txt
@@ -1 +1 @@
-coverage[toml]==7.4.1
+coverage[toml]==7.4.4
diff --git a/dev-requirements/flake8.txt b/dev-requirements/flake8.txt
@@ -5,7 +5,7 @@ flake8==7.0.0
 
 flake8-bandit~=4.1.1                    # runs bandit
 flake8-black==0.3.6                     # runs black
-flake8-builtins==2.2.0                  # builtin shadowing checks
+flake8-builtins==2.5.0                  # builtin shadowing checks
 flake8-coding==1.3.2                    # coding magic-comment detection
 flake8-comprehensions==3.14.0           # comprehension checks
 flake8-docstrings==1.7.0                # pydocstyle support
@@ -18,7 +18,7 @@ flake8-mutable==1.2.0                   # mutable default argument detection
 flake8-pep3101==2.1.0                   # new-style format strings only
 flake8-print==5.0.0                     # complain about print statements in code
 flake8-printf-formatting==1.1.2         # forbey printf-style python2 string formatting
-flake8-pytest-style==1.7.2              # pytest checks
+flake8-pytest-style==2.0.0              # pytest checks
 flake8-raise==0.0.5                     # exception raising linting
 flake8-use-fstring==1.4                 # format string checking
 flake8-noqa==1.4.0                      # validate noqa commands
diff --git a/dev-requirements/formatting.txt b/dev-requirements/formatting.txt
@@ -1,2 +1,2 @@
-black==24.1.1
+black==24.3.0
 isort==5.13.2
diff --git a/dev-requirements/mkdocs.txt b/dev-requirements/mkdocs.txt
@@ -0,0 +1,18 @@
+mkdocs==1.5.3
+
+# Mkdocs Material
+mkdocs-material[imaging]==9.5.17
+
+# Docstring parsing for API reference
+mkdocstrings[python]==0.24.3
+griffe-inherited-docstrings==1.0.0
+
+# Generate API reference pages dynamically
+mkdocs-gen-files==0.5.0
+mkdocs-literate-nav==0.6.1
+
+# Formatting signatures
+black==24.3.0
+
+# Image viewer ext
+mkdocs-glightbox==0.3.7
diff --git a/dev-requirements/mypy.txt b/dev-requirements/mypy.txt
@@ -1 +1 @@
-mypy==1.8.0
+mypy==1.9.0
diff --git a/dev-requirements/pyright.txt b/dev-requirements/pyright.txt
@@ -1 +1 @@
-pyright==1.1.349
+pyright==1.1.358
diff --git a/dev-requirements/pytest.txt b/dev-requirements/pytest.txt
@@ -1,9 +1,9 @@
 # mock in the stdlib changes between versions of Python, so are not consistent in behaviour like the backport is
 mock==5.1.0
 
-pytest==7.4.4
-pytest-asyncio==0.23.4
-pytest-cov==4.1.0
+pytest==8.1.1
+pytest-asyncio==0.23.6
+pytest-cov==5.0.0
 pytest-randomly==3.15.0
 
 async-timeout==4.0.3  # Used for timeouts in some test cases.

diff --git a/dev-requirements/release.txt b/dev-requirements/release.txt
@@ -1,3 +1,3 @@
-twine==4.0.2
+twine==5.0.0
 
 -r build.txt
diff --git a/dev-requirements/safety.txt b/dev-requirements/safety.txt
@@ -1,4 +1,4 @@
-safety~=3.0
+safety~=3.1
 
 # Temporary addition to avoid safety erroring due to https://github.com/pypa/pip/pull/9827
 pip>=21.1
diff --git a/dev-requirements/slotscheck.txt b/dev-requirements/slotscheck.txt
@@ -1 +1 @@
-slotscheck==0.17.1
+slotscheck==0.19.0
diff --git a/dev-requirements/sphinx.txt b/dev-requirements/sphinx.txt
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/_static/extra.css b/docs/_static/extra.css
diff --git a/docs/_templates/numpydoc_docstring.rst b/docs/_templates/numpydoc_docstring.rst
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Add `message_link` property to `MessageReference`
		- Add `channel_link` property to `MessageReference`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Fix warning raised in aiohttp 3.9.4 when using `FormData` (most commonly, when uploading attachments)