├── .github
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.yml
    │   ├── config.yml
    │   └── feature_request.yml
    ├── PULL_REQUEST_TEMPLATE.md
    └── workflows
    │   ├── bandit.yml
    │   ├── lint.yml
    │   ├── pylint.yml
    │   └── pyright.yml
├── .gitignore
├── .readthedocs.yaml
├── LICENSE
├── MANIFEST.in
├── README.rst
├── assets
    └── LICENSE
├── docs
    ├── LICENSE
    ├── Makefile
    ├── _static
    │   ├── codeblocks.css
    │   ├── copy.js
    │   ├── custom.js
    │   ├── icons.css
    │   ├── icons.woff
    │   ├── scorer.js
    │   ├── settings.js
    │   ├── sidebar.js
    │   └── style.css
    ├── _templates
    │   ├── genindex.html
    │   ├── layout.html
    │   └── relations.html
    ├── api.rst
    ├── conf.py
    ├── extensions
    │   ├── attributetable.py
    │   ├── builder.py
    │   ├── details.py
    │   ├── exception_hierarchy.py
    │   ├── nitpick_file_ignorer.py
    │   └── resourcelinks.py
    ├── images
    │   ├── Github-Python-rounded.png
    │   ├── Github-Python.png
    │   ├── discord_py_logo.ico
    │   ├── drop_down_icon.svg
    │   ├── icon.ico
    │   ├── snake.svg
    │   └── snake_dark.svg
    ├── index.rst
    ├── make.bat
    └── requirements.txt
├── github
    ├── __init__.py
    ├── cache.py
    ├── client.py
    ├── exceptions.py
    ├── http.py
    ├── objects.py
    └── urls.py
├── pyproject.toml
├── requirements.txt
├── setup.cfg
└── setup.py


/.github/ISSUE_TEMPLATE/bug_report.yml:
--------------------------------------------------------------------------------
 1 | # Credits to most of this template go to Rapptz (https://github.com/Rapptz)
 2 | # as this was taken from the discord.py repository (https://github.com/Rapptz/discord.py/blob/868476c99963e72aa529ed6203f86ef529a2c1f1/.github/ISSUE_TEMPLATE/bug_report.yml)
 3 | name: Bug Report
 4 | 
 5 | description: Report broken or incorrect behaviour
 6 | 
 7 | labels:
 8 |   - bug
 9 | 
10 | body:
11 |   - type: markdown
12 |     attributes:
13 |       value: |
14 |         Thanks for taking the time to fill out a bug.
15 |         If you want real-time support, consider joining our [Discord server](https://discord.gg/pTJfS4TkWe) instead.
16 | 
17 |         Please note that this form is for bugs only!
18 | 
19 |   - type: input
20 |     attributes:
21 |       label: Summary
22 |       description: A simple summary of your bug report.
23 |     validations:
24 |       required: true
25 | 
26 |   - type: textarea
27 |     attributes:
28 |       label: Reproduction Steps
29 |       description: What you do to make it happen?
30 |     validations:
31 |       required: true
32 | 
33 |   - type: textarea
34 |     attributes:
35 |       label: Minimal Reproducible Code
36 |       description: A short snippet of code that showcases the bug.
37 |       render: Python
38 | 
39 |   - type: textarea
40 |     attributes:
41 |       label: Expected Results
42 |       description: What did you expect to happen?
43 |     validations:
44 |       required: true
45 | 
46 |   - type: textarea
47 |     attributes:
48 |       label: Actual Results
49 |       description: What actually happened?
50 |     validations:
51 |       required: true
52 | 
53 |   - type: checkboxes
54 |     attributes:
55 |       label: Checklist
56 |       description: |
57 |         Let's make sure you've properly done due diligence when reporting this issue!
58 |       options:
59 |         - label: I have searched the open issues for duplicates.
60 |           required: true
61 |         - label: I have shown the entire traceback, if possible.
62 |           required: true
63 |         - label: I have removed my token from display, if visible.
64 |           required: true
65 | 
66 |   - type: textarea
67 |     attributes:
68 |       label: Additional Context
69 |       description: If there is anything else to say, please do so here.
70 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | contact_links:
2 |   - name: Discord Server
3 |     about: Use our official Discord server to ask for help and questions.
4 |     url: https://discord.gg/pTJfS4TkWe
5 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.yml:
--------------------------------------------------------------------------------
 1 | # Credits to most of this template go to Rapptz (https://github.com/Rapptz)
 2 | # as this was taken from the discord.py repository (https://github.com/Rapptz/discord.py/blob/868476c99963e72aa529ed6203f86ef529a2c1f1/.github/ISSUE_TEMPLATE/feature_request.yml)
 3 | name: Feature Request
 4 | 
 5 | description: Suggest a feature for this library
 6 | 
 7 | labels:
 8 |   - enhancement
 9 | 
10 | body:
11 |   - type: input
12 |     attributes:
13 |       label: Summary
14 |       description: A short summary of what your feature request is.
15 |     validations:
16 |       required: true
17 | 
18 |   - type: dropdown
19 |     attributes:
20 |       multiple: false
21 |       label: What is the feature request for?
22 |       options:
23 |         - The library
24 |         - The documentation
25 |     validations:
26 |       required: true
27 | 
28 |   - type: textarea
29 |     attributes:
30 |       label: The Problem
31 |       description: |
32 |         What problem is your feature trying to solve?
33 |         What becomes easier or possible when this feature is implemented?
34 |     validations:
35 |       required: true
36 | 
37 |   - type: textarea
38 |     attributes:
39 |       label: The Ideal Solution
40 |       description: |
41 |         What is your ideal solution to the problem?
42 |         What would you like this feature to do?
43 |     validations:
44 |       required: true
45 | 
46 |   - type: textarea
47 |     attributes:
48 |       label: The Current Solution
49 |       description: What is the current solution to the problem, if any?
50 |     validations:
51 |       required: false
52 | 
53 |   - type: textarea
54 |     attributes:
55 |       label: Additional Context
56 |       description: If there is anything else to say, please do so here.
57 | 


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE.md:
--------------------------------------------------------------------------------
 1 | ## Summary
 2 | 
 3 | <!-- Summary of your pull request -->
 4 | 
 5 | ## Checklist
 6 | 
 7 | <!-- Put an x inside [ ] to check it, like so: [x] -->
 8 | 
 9 | - [ ] If code changes were made then they have been tested.
10 |     - [ ] I have updated the documentation to reflect the changes.
11 | - [ ] This PR fixes an issue.
12 | - [ ] This PR adds something new (e.g. new method or parameters).
13 | - [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
14 | - [ ] This PR is **not** a code change (e.g. documentation, README, ...)
15 | 


--------------------------------------------------------------------------------
/.github/workflows/bandit.yml:
--------------------------------------------------------------------------------
 1 | name: Bandit
 2 | 
 3 | on: [ pull_request, push ]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     if: github.event.pull_request.user.type != 'Bot'
 8 |     runs-on: ubuntu-latest
 9 |     strategy:
10 |       matrix:
11 |         python-version: [ '3.8', '3.9', '3.10' ]
12 | 
13 |     steps:
14 |       - name: Checkout Repository
15 |         uses: actions/checkout@v3
16 | 
17 |       - name: Set up Python ${{ matrix.python-version }}
18 |         uses: actions/setup-python@v2
19 |         with:
20 |           python-version: ${{ matrix.python-version }}
21 | 
22 |       - name: Install Bandit
23 |         run: pip install -U pip bandit
24 | 
25 |       - name: Run Bandit
26 |         run: bandit --recursive ./
27 | 


--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
 1 | name: Lint
 2 | 
 3 | on: [ pull_request, push ]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     if: github.event.pull_request.user.type != 'Bot'
 8 |     runs-on: ubuntu-latest
 9 |     strategy:
10 |       matrix:
11 |         python-version: [ '3.8', '3.9', '3.10' ]
12 | 
13 |     steps:
14 |       - name: Checkout Repository
15 |         uses: actions/checkout@v3
16 | 
17 |       - name: Set up Python ${{ matrix.python-version }}
18 |         uses: actions/setup-python@v2
19 |         with:
20 |           python-version: ${{ matrix.python-version }}
21 | 
22 |       - name: Install Unimport, Isort, Black, and Flynt
23 |         run: pip install -U pip unimport isort black flynt
24 | 
25 |       - name: Run Unimport
26 |         continue-on-error: true
27 |         run: unimport ./ --ignore-init --gitignore -r
28 | 
29 |       - name: Run Isort
30 |         run: isort ./
31 | 
32 |       - name: Run Black
33 |         run: black ./
34 | 
35 |       - name: Run Flynt
36 |         run: flynt ./ -tc
37 | 
38 |       - name: Setup Git
39 |         run: git config user.name "Automated Linter"
40 | 
41 |       - name: Push To GitHub
42 |         continue-on-error: true
43 |         run: |
44 |           git pull
45 |           git add ./
46 |           git commit --reuse-message=HEAD
47 |           git push
48 | 


--------------------------------------------------------------------------------
/.github/workflows/pylint.yml:
--------------------------------------------------------------------------------
 1 | name: PyLint
 2 | 
 3 | on: [ pull_request, push ]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     if: github.event.pull_request.user.type != 'Bot'
 8 |     runs-on: ubuntu-latest
 9 |     strategy:
10 |       matrix:
11 |         python-version: [ '3.8', '3.9', '3.10' ]
12 | 
13 |     steps:
14 |       - name: Checkout Repository
15 |         uses: actions/checkout@v3
16 | 
17 |       - name: Set up Python ${{ matrix.python-version }}
18 |         uses: actions/setup-python@v2
19 |         with:
20 |           python-version: ${{ matrix.python-version }}
21 | 
22 |       - name: Install PyLint
23 |         run: pip install -U pip pylint
24 | 
25 |       - name: Run PyLint
26 |         run: pylint $(git ls-files '*.py')
27 | 


--------------------------------------------------------------------------------
/.github/workflows/pyright.yml:
--------------------------------------------------------------------------------
 1 | name: PyRight
 2 | 
 3 | on: [ pull_request, push ]
 4 | 
 5 | jobs:
 6 |   build:
 7 |     if: github.event.pull_request.user.type != 'Bot'
 8 |     runs-on: ubuntu-latest
 9 |     strategy:
10 |       matrix:
11 |         python-version: [ '3.8', '3.9', '3.10' ]
12 | 
13 |     steps:
14 |       - name: Checkout Repository
15 |         uses: actions/checkout@v3
16 | 
17 |       - name: Set up Python ${{ matrix.python-version }}
18 |         uses: actions/setup-python@v2
19 |         with:
20 |           python-version: ${{ matrix.python-version }}
21 | 
22 |       - name: Install PyRight & Dependencies
23 |         run: |
24 |           pip install -U pip pyright
25 |           pip install -Ur requirements.txt
26 | 
27 |       - name: Run PyRight
28 |         run: pyright ./
29 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | # Used for developer debugging
  2 | shell.py
  3 | 
  4 | # Byte-compiled / optimized / DLL files
  5 | __pycache__/
  6 | *.py[cod]
  7 | *$py.class
  8 | 
  9 | #var is weird
 10 | test*.*
 11 | .vscode/
 12 | 
 13 | # C extensions
 14 | *.so
 15 | 
 16 | # Distribution / packaging
 17 | .Python
 18 | build/
 19 | develop-eggs/
 20 | dist/
 21 | downloads/
 22 | eggs/
 23 | .eggs/
 24 | lib/
 25 | lib64/
 26 | parts/
 27 | sdist/
 28 | var/
 29 | wheels/
 30 | pip-wheel-metadata/
 31 | share/python-wheels/
 32 | *.egg-info/
 33 | .installed.cfg
 34 | *.egg
 35 | MANIFEST
 36 | 
 37 | # PyInstaller
 38 | #  Usually these files are written by a python script from a template
 39 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 40 | *.manifest
 41 | *.spec
 42 | 
 43 | # Installer logs
 44 | pip-log.txt
 45 | pip-delete-this-directory.txt
 46 | 
 47 | # Unit test / coverage reports
 48 | htmlcov/
 49 | .tox/
 50 | .nox/
 51 | .coverage
 52 | .coverage.*
 53 | .cache
 54 | nosetests.xml
 55 | coverage.xml
 56 | *.cover
 57 | *.py,cover
 58 | .hypothesis/
 59 | .pytest_cache/
 60 | 
 61 | # Translations
 62 | *.mo
 63 | *.pot
 64 | 
 65 | # Django stuff:
 66 | *.log
 67 | local_settings.py
 68 | db.sqlite3
 69 | db.sqlite3-journal
 70 | 
 71 | # Flask stuff:
 72 | instance/
 73 | .webassets-cache
 74 | 
 75 | # Scrapy stuff:
 76 | .scrapy
 77 | 
 78 | # Sphinx documentation
 79 | docs/_build/
 80 | 
 81 | # PyBuilder
 82 | target/
 83 | 
 84 | # Jupyter Notebook
 85 | .ipynb_checkpoints
 86 | 
 87 | # IPython
 88 | profile_default/
 89 | ipython_config.py
 90 | 
 91 | # pyenv
 92 | .python-version
 93 | 
 94 | # pipenv
 95 | #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 96 | #   However, in case of collaboration, if having platform-specific dependencies or dependencies
 97 | #   having no cross-platform support, pipenv may install dependencies that don't work, or not
 98 | #   install all needed dependencies.
 99 | #Pipfile.lock
100 | 
101 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
102 | __pypackages__/
103 | 
104 | # Celery stuff
105 | celerybeat-schedule
106 | celerybeat.pid
107 | 
108 | # SageMath parsed files
109 | *.sage.py
110 | 
111 | # Environments
112 | .env
113 | .venv
114 | env/
115 | venv/
116 | ENV/
117 | env.bak/
118 | venv.bak/
119 | 
120 | # Spyder project settings
121 | .spyderproject
122 | .spyproject
123 | 
124 | # Rope project settings
125 | .ropeproject
126 | 
127 | # mkdocs documentation
128 | /site
129 | 
130 | # mypy
131 | .mypy_cache/
132 | .dmypy.json
133 | dmypy.json
134 | 
135 | # Pyre type checker
136 | .pyre/
137 | 


--------------------------------------------------------------------------------
/.readthedocs.yaml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | 
 3 | sphinx:
 4 |   configuration: docs/conf.py
 5 |   fail_on_warning: false
 6 |   builder: html
 7 |   
 8 | python:
 9 |   version: '3.8'
10 |   install:
11 |     - method: pip
12 |       path: .
13 |     - requirements: docs/requirements.txt
14 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022-present VarMonke and sudosnok
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include README.rst
2 | include LICENSE
3 | include requirements.txt
4 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
 1 | Github API Wrapper(Development on hold till May 2025)
 2 | ==================
 3 | 
 4 | Please note that development is currently on hold until May 2025. As I am in the final year of my studies, I am unable to actively maintain this project at the moment. However, I plan to resume development as soon as possible. Upon reviewing the code recently, I identified several redundancies and areas that could benefit from significant improvement, which I intend to address once development resumes.
 5 | 
 6 | .. image:: https://discord.com/api/guilds/963406460107235328/widget.png
 7 |   :target: https://discord.gg/DWhwsQ5TsT
 8 |   :alt: Discord Server Invite
 9 | 
10 | Easy to use Python wrapper for the **Github API**.
11 | 
12 | Key Features
13 | ------------
14 | - Modern Pythonic Interface
15 | - Easy to use
16 | 
17 | 
18 | Installing
19 | ----------
20 | 
21 | **Python 3.8 or higher is required to run the library**
22 | 
23 | To install the library, run the following command:
24 | 
25 | .. code:: sh
26 | 
27 |   # On Linux or MacOS
28 |   python3 -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
29 |   
30 |   # On Windows
31 |   py -m pip install -U git+https://github.com/VarMonke/Github-Api-Wrapper
32 |   
33 | Quick Example
34 | -------------
35 |   
36 | .. code:: py
37 |   
38 |   import github
39 |   import asyncio
40 |   
41 |   async def main():
42 |     client = await github.GHClient()
43 | 
44 |     user = await client.get_user(user='GithubPythonBot')
45 | 
46 |     print(user)
47 |     print(user.html_url)
48 | 
49 |   asyncio.run(main())
50 | 
51 | .. code:: sh
52 |   # Output
53 |   <User login: 'GithubPythonBot', id: 104489846, created_at: 2022-04-27 07:31:26>
54 |   https://github.com/GithubPythonBot
55 | 
56 |   
57 | Links
58 | -----
59 | - `Discord Server <https://discord.gg/DWhwsQ5TsT>`_
60 | - `GitHub API Documentation <https://docs.github.com/en/rest>`_
61 | 


--------------------------------------------------------------------------------
/assets/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2022-present Jess, VarMonke and sudosnok
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/docs/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2015-2022 Rapptz
 4 | Copyright (c) 2022-present VarMonke and sudosnok
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a copy
 7 | of this software and associated documentation files (the "Software"), to deal
 8 | in the Software without restriction, including without limitation the rights
 9 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 | copies of the Software, and to permit persons to whom the Software is
11 | furnished to do so, subject to the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be included in all
14 | copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 | SOFTWARE.
23 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = _build
  9 | 
 10 | # User-friendly check for sphinx-build
 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
 13 | endif
 14 | 
 15 | # Internal variables.
 16 | PAPEROPT_a4     = -D latex_paper_size=a4
 17 | PAPEROPT_letter = -D latex_paper_size=letter
 18 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 19 | # the i18n builder cannot share the environment and doctrees with the others
 20 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 21 | 
 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
 23 | 
 24 | help:
 25 | 	@echo "Please use \`make <target>' where <target> is one of"
 26 | 	@echo "  html       to make standalone HTML files"
 27 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 28 | 	@echo "  singlehtml to make a single large HTML file"
 29 | 	@echo "  pickle     to make pickle files"
 30 | 	@echo "  json       to make JSON files"
 31 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 32 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 33 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 34 | 	@echo "  epub       to make an epub"
 35 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 36 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 37 | 	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 38 | 	@echo "  text       to make text files"
 39 | 	@echo "  man        to make manual pages"
 40 | 	@echo "  texinfo    to make Texinfo files"
 41 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 42 | 	@echo "  gettext    to make PO message catalogs"
 43 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 44 | 	@echo "  xml        to make Docutils-native XML files"
 45 | 	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
 46 | 	@echo "  linkcheck  to check all external links for integrity"
 47 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 48 | 	@echo "  coverage   to run coverage check of the documentation (if enabled)"
 49 | 
 50 | clean:
 51 | 	rm -rf $(BUILDDIR)/*
 52 | 
 53 | html:
 54 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 55 | 	@echo
 56 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 57 | 
 58 | dirhtml:
 59 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 60 | 	@echo
 61 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 62 | 
 63 | singlehtml:
 64 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 65 | 	@echo
 66 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 67 | 
 68 | pickle:
 69 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 70 | 	@echo
 71 | 	@echo "Build finished; now you can process the pickle files."
 72 | 
 73 | json:
 74 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 75 | 	@echo
 76 | 	@echo "Build finished; now you can process the JSON files."
 77 | 
 78 | htmlhelp:
 79 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 80 | 	@echo
 81 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 82 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 83 | 
 84 | qthelp:
 85 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 86 | 	@echo
 87 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 88 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 89 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/discord.py.qhcp"
 90 | 	@echo "To view the help file:"
 91 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/discord.py.qhc"
 92 | 
 93 | devhelp:
 94 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 95 | 	@echo
 96 | 	@echo "Build finished."
 97 | 	@echo "To view the help file:"
 98 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/discord.py"
 99 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/discord.py"
100 | 	@echo "# devhelp"
101 | 
102 | epub:
103 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
104 | 	@echo
105 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
106 | 
107 | latex:
108 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
109 | 	@echo
110 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
111 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
112 | 	      "(use \`make latexpdf' here to do that automatically)."
113 | 
114 | latexpdf:
115 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
116 | 	@echo "Running LaTeX files through pdflatex..."
117 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
118 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
119 | 
120 | latexpdfja:
121 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
122 | 	@echo "Running LaTeX files through platex and dvipdfmx..."
123 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
124 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
125 | 
126 | text:
127 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
128 | 	@echo
129 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
130 | 
131 | man:
132 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
133 | 	@echo
134 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
135 | 
136 | texinfo:
137 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
138 | 	@echo
139 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
140 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
141 | 	      "(use \`make info' here to do that automatically)."
142 | 
143 | info:
144 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
145 | 	@echo "Running Texinfo files through makeinfo..."
146 | 	make -C $(BUILDDIR)/texinfo info
147 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
148 | 
149 | gettext:
150 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
151 | 	@echo
152 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
153 | 
154 | changes:
155 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
156 | 	@echo
157 | 	@echo "The overview file is in $(BUILDDIR)/changes."
158 | 
159 | linkcheck:
160 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
161 | 	@echo
162 | 	@echo "Link check complete; look for any errors in the above output " \
163 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
164 | 
165 | doctest:
166 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
167 | 	@echo "Testing of doctests in the sources finished, look at the " \
168 | 	      "results in $(BUILDDIR)/doctest/output.txt."
169 | 
170 | coverage:
171 | 	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
172 | 	@echo "Testing of coverage in the sources finished, look at the " \
173 | 	      "results in $(BUILDDIR)/coverage/python.txt."
174 | 
175 | xml:
176 | 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
177 | 	@echo
178 | 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
179 | 
180 | pseudoxml:
181 | 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
182 | 	@echo
183 | 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
184 | 


--------------------------------------------------------------------------------
/docs/_static/codeblocks.css:
--------------------------------------------------------------------------------
  1 | /* light theme: default */
  2 | .highlight .hll { background-color: #ffffcc }
  3 | .highlight  { background: #f0f0f0; }
  4 | .highlight .c { color: #60a0b0; font-style: italic } /* Comment */
  5 | .highlight .err { border: 1px solid #FF0000 } /* Error */
  6 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */
  7 | .highlight .o { color: #666666 } /* Operator */
  8 | .highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
  9 | .highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
 10 | .highlight .cp { color: #007020 } /* Comment.Preproc */
 11 | .highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
 12 | .highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
 13 | .highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
 14 | .highlight .gd { color: #A00000 } /* Generic.Deleted */
 15 | .highlight .ge { font-style: italic } /* Generic.Emph */
 16 | .highlight .gr { color: #FF0000 } /* Generic.Error */
 17 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 18 | .highlight .gi { color: #00A000 } /* Generic.Inserted */
 19 | .highlight .go { color: #888888 } /* Generic.Output */
 20 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
 21 | .highlight .gs { font-weight: bold } /* Generic.Strong */
 22 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
 23 | .highlight .gt { color: #0044DD } /* Generic.Traceback */
 24 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
 25 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
 26 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
 27 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */
 28 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
 29 | .highlight .kt { color: #902000 } /* Keyword.Type */
 30 | .highlight .m { color: #40a070 } /* Literal.Number */
 31 | .highlight .s { color: #4070a0 } /* Literal.String */
 32 | .highlight .na { color: #4070a0 } /* Name.Attribute */
 33 | .highlight .nb { color: #007020 } /* Name.Builtin */
 34 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
 35 | .highlight .no { color: #60add5 } /* Name.Constant */
 36 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
 37 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
 38 | .highlight .ne { color: #007020 } /* Name.Exception */
 39 | .highlight .nf { color: #06287e } /* Name.Function */
 40 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
 41 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
 42 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
 43 | .highlight .nv { color: #bb60d5 } /* Name.Variable */
 44 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
 45 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */
 46 | .highlight .mb { color: #40a070 } /* Literal.Number.Bin */
 47 | .highlight .mf { color: #40a070 } /* Literal.Number.Float */
 48 | .highlight .mh { color: #40a070 } /* Literal.Number.Hex */
 49 | .highlight .mi { color: #40a070 } /* Literal.Number.Integer */
 50 | .highlight .mo { color: #40a070 } /* Literal.Number.Oct */
 51 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */
 52 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
 53 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */
 54 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
 55 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
 56 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */
 57 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
 58 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
 59 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
 60 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */
 61 | .highlight .sr { color: #235388 } /* Literal.String.Regex */
 62 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */
 63 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */
 64 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
 65 | .highlight .fm { color: #06287e } /* Name.Function.Magic */
 66 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
 67 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
 68 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
 69 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
 70 | .highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */
 71 | 
 72 | /* dark theme: modified "native" */
 73 | :root[data-theme="dark"] .highlight pre { background-color: #2a2a2e }
 74 | :root[data-theme="dark"] .highlight .hll { background-color: #2a2a2e }
 75 | :root[data-theme="dark"] .highlight .c { color: #999999; font-style: italic } /* Comment */
 76 | :root[data-theme="dark"] .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
 77 | :root[data-theme="dark"] .highlight .g { color: #d0d0d0 } /* Generic */
 78 | :root[data-theme="dark"] .highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
 79 | :root[data-theme="dark"] .highlight .l { color: #d0d0d0 } /* Literal */
 80 | :root[data-theme="dark"] .highlight .n { color: #d0d0d0 } /* Name */
 81 | :root[data-theme="dark"] .highlight .o { color: #d0d0d0 } /* Operator */
 82 | :root[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */
 83 | :root[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */
 84 | :root[data-theme="dark"] .highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
 85 | :root[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
 86 | :root[data-theme="dark"] .highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
 87 | :root[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
 88 | :root[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */
 89 | :root[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
 90 | :root[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */
 91 | :root[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */
 92 | :root[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */
 93 | :root[data-theme="dark"] .highlight .go { color: #cccccc } /* Generic.Output */
 94 | :root[data-theme="dark"] .highlight .gp { color: #aaaaaa } /* Generic.Prompt */
 95 | :root[data-theme="dark"] .highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
 96 | :root[data-theme="dark"] .highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
 97 | :root[data-theme="dark"] .highlight .gt { color: #d22323 } /* Generic.Traceback */
 98 | :root[data-theme="dark"] .highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
 99 | :root[data-theme="dark"] .highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
100 | :root[data-theme="dark"] .highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
101 | :root[data-theme="dark"] .highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
102 | :root[data-theme="dark"] .highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
103 | :root[data-theme="dark"] .highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
104 | :root[data-theme="dark"] .highlight .ld { color: #d0d0d0 } /* Literal.Date */
105 | :root[data-theme="dark"] .highlight .m { color: #7fb1d7 } /* Literal.Number */
106 | :root[data-theme="dark"] .highlight .s { color: #ed9d13 } /* Literal.String */
107 | :root[data-theme="dark"] .highlight .na { color: #bbbbbb; } /* Name.Attribute */
108 | :root[data-theme="dark"] .highlight .nb { color: #29a5b3; } /* Name.Builtin */
109 | :root[data-theme="dark"] .highlight .nc { color: #6494d8;} /* Name.Class */
110 | :root[data-theme="dark"] .highlight .no { color: #40ffff; } /* Name.Constant */
111 | :root[data-theme="dark"] .highlight .nd { color: #ffa500; } /* Name.Decorator */
112 | :root[data-theme="dark"] .highlight .ni { color: #d0d0d0; } /* Name.Entity */
113 | :root[data-theme="dark"] .highlight .ne { color: #bbbbbb; } /* Name.Exception */
114 | :root[data-theme="dark"] .highlight .nf { color: #6494d8; } /* Name.Function */
115 | :root[data-theme="dark"] .highlight .fm { color: #6494d8; } /* Name.Function.Magic */
116 | :root[data-theme="dark"] .highlight .nl { color: #d0d0d0; } /* Name.Label */
117 | :root[data-theme="dark"] .highlight .nn { color: #6494d8;} /* Name.Namespace */
118 | :root[data-theme="dark"] .highlight .nx { color: #d0d0d0; } /* Name.Other */
119 | :root[data-theme="dark"] .highlight .py { color: #d0d0d0; } /* Name.Property */
120 | :root[data-theme="dark"] .highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
121 | :root[data-theme="dark"] .highlight .nv { color: #40ffff; } /* Name.Variable */
122 | :root[data-theme="dark"] .highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
123 | :root[data-theme="dark"] .highlight .w  { color: #666666; } /* Text.Whitespace */
124 | :root[data-theme="dark"] .highlight .mf { color: #7fb1d7; } /* Literal.Number.Float */
125 | :root[data-theme="dark"] .highlight .mh { color: #7fb1d7; } /* Literal.Number.Hex */
126 | :root[data-theme="dark"] .highlight .mi { color: #7fb1d7; } /* Literal.Number.Integer */
127 | :root[data-theme="dark"] .highlight .mo { color: #7fb1d7; } /* Literal.Number.Oct */
128 | :root[data-theme="dark"] .highlight .sb { color: #ed9d13; } /* Literal.String.Backtick */
129 | :root[data-theme="dark"] .highlight .sc { color: #ed9d13; } /* Literal.String.Char */
130 | :root[data-theme="dark"] .highlight .sd { color: #ed9d13; } /* Literal.String.Doc */
131 | :root[data-theme="dark"] .highlight .s2 { color: #ed9d13; } /* Literal.String.Double */
132 | :root[data-theme="dark"] .highlight .se { color: #ed9d13; } /* Literal.String.Escape */
133 | :root[data-theme="dark"] .highlight .sh { color: #ed9d13; } /* Literal.String.Heredoc */
134 | :root[data-theme="dark"] .highlight .si { color: #ed9d13; } /* Literal.String.Interpol */
135 | :root[data-theme="dark"] .highlight .sx { color: #ffa500; } /* Literal.String.Other */
136 | :root[data-theme="dark"] .highlight .sr { color: #ed9d13; } /* Literal.String.Regex */
137 | :root[data-theme="dark"] .highlight .s1 { color: #ed9d13; } /* Literal.String.Single */
138 | :root[data-theme="dark"] .highlight .ss { color: #ed9d13; } /* Literal.String.Symbol */
139 | :root[data-theme="dark"] .highlight .bp { color: #29a5b3; } /* Name.Builtin.Pseudo */
140 | :root[data-theme="dark"] .highlight .vc { color: #40ffff; } /* Name.Variable.Class */
141 | :root[data-theme="dark"] .highlight .vg { color: #40ffff; } /* Name.Variable.Global */
142 | :root[data-theme="dark"] .highlight .vi { color: #40ffff; } /* Name.Variable.Instance */
143 | :root[data-theme="dark"] .highlight .il { color: #7fb1d7; } /* Literal.Number.Integer.Long */
144 | 


--------------------------------------------------------------------------------
/docs/_static/copy.js:
--------------------------------------------------------------------------------
 1 | const COPY = "content_copy";
 2 | const COPIED = "done";
 3 | 
 4 | const copy = async (obj) => {
 5 |   // <span class="copy"><span class="material-icons">{{text}}</span></span>
 6 |   await navigator.clipboard.writeText(obj.children[1].innerText).then(
 7 |     () => {
 8 |       let icon = obj.children[0].children[0];
 9 |       icon.textContent = COPIED;
10 |       setTimeout(() => (icon.textContent = COPY), 2500);
11 |     },
12 |     (r) => alert('Could not copy codeblock:\n' + r.toString())
13 |   );
14 | };
15 | 
16 | document.addEventListener("DOMContentLoaded", () => {
17 |   let allCodeblocks = document.querySelectorAll("div[class='highlight']");
18 | 
19 |   for (let codeblock of allCodeblocks) {
20 |     codeblock.parentNode.className += " relative-copy";
21 |     let copyEl = document.createElement("span");
22 |     copyEl.addEventListener('click', () => copy(codeblock));
23 |     copyEl.className = "copy";
24 |     copyEl.setAttribute("aria-label", "Copy Code");
25 |     copyEl.setAttribute("title", "Copy Code");
26 | 
27 |     let copyIcon = document.createElement("span");
28 |     copyIcon.className = "material-icons";
29 |     copyIcon.textContent = COPY;
30 |     copyEl.append(copyIcon);
31 | 
32 |     codeblock.prepend(copyEl);
33 |   }
34 | });
35 | 


--------------------------------------------------------------------------------
/docs/_static/custom.js:
--------------------------------------------------------------------------------
  1 | 'use-strict';
  2 | 
  3 | let activeModal = null;
  4 | let bottomHeightThreshold, sections;
  5 | let hamburgerToggle;
  6 | let mobileSearch;
  7 | let sidebar;
  8 | let toTop;
  9 | 
 10 | class Modal {
 11 |   constructor(element) {
 12 |     this.element = element;
 13 |   }
 14 | 
 15 |   close() {
 16 |     activeModal = null;
 17 |     this.element.style.display = 'none'
 18 |   }
 19 | 
 20 |   open() {
 21 |     if (activeModal) {
 22 |       activeModal.close();
 23 |     }
 24 |     activeModal = this;
 25 |     this.element.style.display = 'flex'
 26 |   }
 27 | }
 28 | 
 29 | class SearchBar {
 30 | 
 31 |   constructor() {
 32 |     this.box = document.querySelector('nav.mobile-only');
 33 |     this.bar = document.querySelector('nav.mobile-only input[type="search"]');
 34 |     this.openButton = document.getElementById('open-search');
 35 |     this.closeButton = document.getElementById('close-search');
 36 |   }
 37 | 
 38 |   open() {
 39 |     this.openButton.hidden = true;
 40 |     this.closeButton.hidden = false;
 41 |     this.box.style.top = "100%";
 42 |     this.bar.focus();
 43 |   }
 44 | 
 45 |   close() {
 46 |     this.openButton.hidden = false;
 47 |     this.closeButton.hidden = true;
 48 |     this.box.style.top = "0";
 49 |   }
 50 | 
 51 | }
 52 | 
 53 | function scrollToTop() {
 54 |   window.scrollTo({ top: 0, behavior: 'smooth' });
 55 | }
 56 | 
 57 | document.addEventListener('DOMContentLoaded', () => {
 58 |   mobileSearch = new SearchBar();
 59 | 
 60 |   bottomHeightThreshold = document.documentElement.scrollHeight - 30;
 61 |   sections = document.querySelectorAll('section');
 62 |   hamburgerToggle = document.getElementById('hamburger-toggle');
 63 |   
 64 |   toTop = document.getElementById('to-top');
 65 |   toTop.hidden = !(window.scrollY > 0);
 66 | 
 67 |   if (hamburgerToggle) {
 68 |     hamburgerToggle.addEventListener('click', (e) => {
 69 |       sidebar.element.classList.toggle('sidebar-toggle');
 70 |       let button = hamburgerToggle.firstElementChild;
 71 |       if (button.textContent == 'menu') {
 72 |         button.textContent = 'close';
 73 |       }
 74 |       else {
 75 |         button.textContent = 'menu';
 76 |       }
 77 |     });
 78 |   }
 79 | 
 80 |   const tables = document.querySelectorAll('.py-attribute-table[data-move-to-id]');
 81 |   tables.forEach(table => {
 82 |     let element = document.getElementById(table.getAttribute('data-move-to-id'));
 83 |     let parent = element.parentNode;
 84 |     // insert ourselves after the element
 85 |     parent.insertBefore(table, element.nextSibling);
 86 |   });
 87 | 
 88 |   window.addEventListener('scroll', () => {
 89 |     toTop.hidden = !(window.scrollY > 0);
 90 |   });
 91 | });
 92 | 
 93 | document.addEventListener('keydown', (event) => {
 94 |   if (event.code == "Escape" && activeModal) {
 95 |     activeModal.close();
 96 |   }
 97 | });
 98 | 
 99 | function searchBarClick(event, which) {
100 |   event.preventDefault();
101 | 
102 |   if (event.button === 1 || event.buttons === 4) {
103 |       which.target = "_blank";  // Middle mouse button was clicked. Set our target to a new tab.
104 |   }
105 |   else if (event.button === 2) {
106 |     return  // Right button was clicked... Don't do anything here.
107 |   }
108 |   else {
109 |     which.target = "_self";  // Revert to same window.
110 |   }
111 | 
112 |   which.submit();
113 | }
114 | 


--------------------------------------------------------------------------------
/docs/_static/icons.css:
--------------------------------------------------------------------------------
 1 | @font-face {
 2 |     font-family: 'Custom Icons';
 3 |     font-style: normal;
 4 |     font-weight: 400;
 5 |     src: url('icons.woff') format('woff2');
 6 | }
 7 | 
 8 | .custom-icons {
 9 |     font-family: 'Custom Icons' !important;
10 | }
11 | 


--------------------------------------------------------------------------------
/docs/_static/icons.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/VarMonke/GitHub-API-Wrapper/dd5d5d4923ef2083f589b15202e87b918a23c3e9/docs/_static/icons.woff


--------------------------------------------------------------------------------
/docs/_static/scorer.js:
--------------------------------------------------------------------------------
 1 | 'use-strict';
 2 | 
 3 | let queryBeingDone = null;
 4 | let pattern = null;
 5 | 
 6 | const escapedRegex = /[-\/\\^$*+?.()|[\]{}]/g;
 7 | function escapeRegex(e) {
 8 |     return e.replace(escapedRegex, '\\$&');
 9 | }
10 | 
11 | // for some reason Sphinx shows some entries twice
12 | // if something has been scored already I'd rather sort it to the bottom
13 | const beenScored = new Set();
14 | 
15 | function __score(haystack, regex) {
16 |     let match = regex.exec(haystack);
17 |     if (match == null) {
18 |         return Number.MAX_VALUE;
19 |     }
20 |     let subLength = match[0].length;
21 |     let start = match.index;
22 |     return (subLength * 1000 + start) / 1000.0;
23 | }
24 | 
25 | // unused for now
26 | function __cleanNamespaces(query) {
27 |     return query.replace(/(discord\.(ext\.)?)?(.+)/, '$3');
28 | }
29 | 
30 | Scorer = {
31 | 
32 |     // Implement the following function to further tweak the score for each result
33 |     // The function takes a result array [filename, title, anchor, descr, score]
34 |     // and returns the new score.
35 |     score: (result) => {
36 |         // only inflate the score of things that are actual API reference things
37 |         const [, title, , , score] = result;
38 | 
39 |         if (pattern !== null && title.startsWith('discord.')) {
40 |             let _score = __score(title, pattern);
41 |             if (_score === Number.MAX_VALUE) {
42 |                 return score;
43 |             }
44 |             if (beenScored.has(title)) {
45 |                 return 0;
46 |             }
47 |             beenScored.add(title);
48 |             let newScore = 100 + queryBeingDone.length - _score;
49 |             // console.log(`${title}: ${score} -> ${newScore} (${_score})`);
50 |             return newScore;
51 |         }
52 |         return score;
53 |     },
54 | 
55 |     // query matches the full name of an object
56 |     objNameMatch: 15,
57 |     // or matches in the last dotted part of the object name
58 |     objPartialMatch: 11,
59 |     // Additive scores depending on the priority of the object
60 |     objPrio: {
61 |         0: 15,  // used to be importantResults
62 |         1: 7,   // used to be objectResults
63 |         2: -5   // used to be unimportantResults
64 |     },
65 |     //  Used when the priority is not in the mapping.
66 |     objPrioDefault: 0,
67 | 
68 |     // query found in title
69 |     title: 15,
70 |     partialTitle: 7,
71 |     // query found in terms
72 |     term: 5,
73 |     partialTerm: 2
74 | };
75 | 
76 | document.addEventListener('DOMContentLoaded', () => {
77 |     const params = new URLSearchParams(window.location.search);
78 |     queryBeingDone = params.get('q');
79 |     if (queryBeingDone) {
80 |         let pattern = Array.from(queryBeingDone).map(escapeRegex).join('.*?');
81 |         pattern = new RegExp(pattern, 'i');
82 |     }
83 | });
84 | 


--------------------------------------------------------------------------------
/docs/_static/settings.js:
--------------------------------------------------------------------------------
  1 | 'use-strict';
  2 | 
  3 | let settingsModal;
  4 | 
  5 | class Setting {
  6 |   constructor(name, defaultValue, setter) {
  7 |     this.name = name;
  8 |     this.defaultValue = defaultValue;
  9 |     this.setValue = setter;
 10 |   }
 11 | 
 12 |   setElement() {
 13 |     throw new TypeError('Abstract methods should be implemented.');
 14 |   }
 15 | 
 16 |   load() {
 17 |     let value = JSON.parse(localStorage.getItem(this.name));
 18 |     this.value = value === null ? this.defaultValue : value;
 19 |     try {
 20 |       this.setValue(this.value);
 21 |     } catch (error) {
 22 |       console.error(`Failed to apply setting "${this.name}" With value:`, this.value);
 23 |       console.error(error);
 24 |     }
 25 |   }
 26 | 
 27 |   update() {
 28 |     throw new TypeError('Abstract methods should be implemented.');
 29 |   }
 30 | 
 31 | }
 32 | 
 33 | class CheckboxSetting extends Setting {
 34 | 
 35 |   setElement() {
 36 |     let element = document.querySelector(`input[name=${this.name}]`);
 37 |     element.checked = this.value;
 38 |   }
 39 | 
 40 |   update(element) {
 41 |     localStorage.setItem(this.name, element.checked);
 42 |     this.setValue(element.checked);
 43 |   }
 44 | 
 45 | }
 46 | 
 47 | class RadioSetting extends Setting {
 48 | 
 49 |   setElement() {
 50 |     let element = document.querySelector(`input[name=${this.name}][value=${this.value}]`);
 51 |     element.checked = true;
 52 |   }
 53 | 
 54 |   update(element) {
 55 |     localStorage.setItem(this.name, `"${element.value}"`);
 56 |     this.setValue(element.value);
 57 |   }
 58 | 
 59 | }
 60 | 
 61 | function getRootAttributeToggle(attributeName, valueName) {
 62 |   function toggleRootAttribute(set) {
 63 |     if (set) {
 64 |       document.documentElement.setAttribute(`data-${attributeName}`, valueName);
 65 |     } else {
 66 |       document.documentElement.removeAttribute(`data-${attributeName}`);
 67 |     }
 68 |   }
 69 |   return toggleRootAttribute;
 70 | }
 71 | 
 72 | function setTheme(value) {
 73 |   if (value === 'automatic') {
 74 |     if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
 75 |       document.documentElement.setAttribute('data-theme', 'dark');
 76 |     } else {
 77 |       document.documentElement.setAttribute('data-theme', 'light');
 78 |     }
 79 |   }
 80 |   else {
 81 |     document.documentElement.setAttribute('data-theme', value);
 82 |   }
 83 | }
 84 | 
 85 | const settings = [
 86 |   new CheckboxSetting('useSerifFont', false, getRootAttributeToggle('font', 'serif')),
 87 |   new RadioSetting('setTheme', 'automatic', setTheme)
 88 | ]
 89 | 
 90 | function updateSetting(element) {
 91 |   let setting = settings.find((s) => s.name == element.name);
 92 |   if (setting) {
 93 |     setting.update(element);
 94 |   }
 95 | }
 96 | 
 97 | for (const setting of settings) {
 98 |   setting.load();
 99 | }
100 | 
101 | document.addEventListener('DOMContentLoaded', () => {
102 |   settingsModal = new Modal(document.querySelector('div#settings.modal'));
103 |   for (const setting of settings) {
104 |     setting.setElement();
105 |   }
106 | });
107 | 


--------------------------------------------------------------------------------
/docs/_static/sidebar.js:
--------------------------------------------------------------------------------
  1 | class Sidebar {
  2 |   constructor(element) {
  3 |     this.element = element;
  4 |     this.activeLink = null;
  5 | 
  6 |     this.element.addEventListener('click', (e) => {
  7 |       // If we click a navigation, close the hamburger menu
  8 |       if (e.target.tagName == 'A' && this.element.classList.contains('sidebar-toggle')) {
  9 |         this.element.classList.remove('sidebar-toggle');
 10 |         let button = hamburgerToggle.firstElementChild;
 11 |         button.textContent = 'menu';
 12 | 
 13 |         // Scroll a little up to actually see the header
 14 |         // Note: this is generally around ~55px
 15 |         // A proper solution is getComputedStyle but it can be slow
 16 |         // Instead let's just rely on this quirk and call it a day
 17 |         // This has to be done after the browser actually processes
 18 |         // the section movement
 19 |         setTimeout(() => window.scrollBy(0, -100), 75);
 20 |       }
 21 |     });
 22 |   }
 23 | 
 24 |   createCollapsableSections() {
 25 |     let toc = this.element.querySelector('ul');
 26 |     if (!toc) {
 27 |       return
 28 |     }
 29 |     let allReferences = toc.querySelectorAll('a.reference.internal:not([href="#"])');
 30 | 
 31 |     for (let ref of allReferences) {
 32 | 
 33 |       let next = ref.nextElementSibling;
 34 | 
 35 |       if (next && next.tagName === "UL") {
 36 | 
 37 |         let icon = document.createElement('span');
 38 |         icon.className = 'material-icons collapsible-arrow expanded';
 39 |         icon.innerText = 'expand_more';
 40 | 
 41 |         if (next.parentElement.tagName == "LI") {
 42 |           next.parentElement.classList.add('no-list-style')
 43 |         }
 44 | 
 45 |         icon.addEventListener('click', () => {
 46 |           if (icon.classList.contains('expanded')) {
 47 |             this.collapseSection(icon);
 48 |           } else {
 49 |             this.expandSection(icon);
 50 |           }
 51 |         })
 52 | 
 53 |         ref.classList.add('ref-internal-padding')
 54 |         ref.parentNode.insertBefore(icon, ref);
 55 |       }
 56 |     }
 57 |   }
 58 | 
 59 |   resize() {
 60 |     let rect = this.element.getBoundingClientRect();
 61 |     this.element.style.height = `calc(100vh - 1em - ${rect.top + document.body.offsetTop}px)`;
 62 |   }
 63 | 
 64 |   collapseSection(icon) {
 65 |     icon.classList.remove('expanded');
 66 |     icon.classList.add('collapsed');
 67 |     let children = icon.nextElementSibling.nextElementSibling;
 68 |     // <arrow><heading>
 69 |     // --> <square><children>
 70 |     setTimeout(() => children.style.display = "none", 75)
 71 |   }
 72 | 
 73 |   expandSection(icon) {
 74 |     icon.classList.remove('collapse');
 75 |     icon.classList.add('expanded');
 76 |     let children = icon.nextElementSibling.nextElementSibling;
 77 |     setTimeout(() => children.style.display = "block", 75)
 78 |   }
 79 | 
 80 |   setActiveLink(section) {
 81 |     if (this.activeLink) {
 82 |       this.activeLink.parentElement.classList.remove('active');
 83 |     }
 84 |     if (section) {
 85 |       this.activeLink = document.querySelector(`#sidebar a[href="#${section.id}"]`);
 86 |       if (this.activeLink) {
 87 |         let headingChildren = this.activeLink.parentElement.parentElement;
 88 |         let heading = headingChildren.previousElementSibling.previousElementSibling;
 89 | 
 90 |         if (heading && headingChildren.style.display === 'none') {
 91 |           this.activeLink = heading;
 92 |         }
 93 |         this.activeLink.parentElement.classList.add('active');
 94 |       }
 95 |     }
 96 |   }
 97 | 
 98 | }
 99 | 
100 | function getCurrentSection() {
101 |   let currentSection;
102 |   if (window.scrollY + window.innerHeight > bottomHeightThreshold) {
103 |     currentSection = sections[sections.length - 1];
104 |   }
105 |   else {
106 |     if (sections) {
107 |       sections.forEach(section => {
108 |         let rect = section.getBoundingClientRect();
109 |         if (rect.top + document.body.offsetTop < 1) {
110 |           currentSection = section;
111 |         }
112 |       });
113 |     }
114 |   }
115 |   return currentSection;
116 | }
117 | 
118 | document.addEventListener('DOMContentLoaded', () => {
119 |   sidebar = new Sidebar(document.getElementById('sidebar'));
120 |   sidebar.resize();
121 |   sidebar.createCollapsableSections();
122 | 
123 |   window.addEventListener('scroll', () => {
124 |     sidebar.setActiveLink(getCurrentSection());
125 |     sidebar.resize();
126 |   });
127 | });
128 | 


--------------------------------------------------------------------------------
/docs/_static/style.css:
--------------------------------------------------------------------------------
   1 | /*
   2 | This theme was created from scratch.
   3 | Historically however, thanks to:
   4 | - Alabaster for being a good base
   5 |   - Which thanks Flask + KR theme
   6 | - Sphinx Readable Theme
   7 |   - Which also proved to be a great base
   8 | */
   9 | 
  10 | /*
  11 |   note: this CSS is "mobile first"
  12 |   The desktop implementation is near the bottom
  13 | */
  14 | 
  15 | * {
  16 |   box-sizing: border-box;
  17 | }
  18 | 
  19 | /* CSS variables would go here */
  20 | :root {
  21 |   --font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
  22 |   --monospace-font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
  23 | 
  24 |   /* palette goes here */
  25 |   --white: #ffffff;
  26 |   --grey-1: #f9f9fa;
  27 |   --grey-1-8: rgba(249, 249, 250, 0.8);
  28 |   --grey-2: #ededf0;
  29 |   --grey-3: #d7d7db;
  30 |   --grey-4: #b1b1b3;
  31 |   --grey-5: #737373;
  32 |   --grey-6: #4a4a4f;
  33 |   --grey-7: #38383d;
  34 |   --grey-8: #2a2a2e;
  35 |   --black: #0c0c0d;
  36 | 
  37 |   --blue-1: #3399ff;
  38 |   --blue-2: #0a84ff;
  39 |   --blue-3: #0060df;
  40 |   --blue-4: #003eaa;
  41 |   --blue-5: #002275;
  42 |   --blue-6: #000f40;
  43 | 
  44 |   --settings: var(--grey-1);
  45 |   --settings-hover: var(--grey-1-8);
  46 |   --main-background: var(--grey-1);
  47 |   --link-text: var(--blue-2);
  48 |   --link-hover-text: var(--blue-6);
  49 |   --main-text: var(--black);
  50 |   --mobile-nav-background: var(--black);
  51 |   --mobile-nav-text: var(--white);
  52 |   --mobile-nav-hover-text: var(--white);
  53 |   --mobile-nav-header-text: var(--white);
  54 |   --nav-background: var(--main-background);
  55 |   --nav-text: var(--grey-6);
  56 |   --nav-hover-text: var(--grey-6);
  57 |   --nav-header-text: var(--black);
  58 |   --sub-header-background: var(--grey-6);
  59 |   --search-border: var(--grey-4);
  60 |   --search-text: var(--white);
  61 |   --search-focus: var(--blue-1);
  62 |   --search-button: var(--grey-1);
  63 |   --search-button-hover: var(--grey-1-8);
  64 |   --search-sidebar-background: var(--grey-1);
  65 |   --search-sidebar-text: var(--grey-7);
  66 |   --footer-text: var(--grey-5);
  67 |   --footer-link: var(--grey-6);
  68 |   --hr-border: var(--grey-2);
  69 |   --main-big-headers-text: var(--black);
  70 |   --main-big-headers-border: var(--grey-4);
  71 |   --main-h5-header-text: var(--black);
  72 |   --main-h6-header-text: var(--grey-4);
  73 |   --main-h4-header-border: var(--grey-4);
  74 |   --header-link: var(--grey-6);
  75 |   --header-link-hover-text: var(--white);
  76 |   --admonition-background: var(--grey-2);
  77 |   --note-background: var(--blue-1);
  78 |   --note-text: var(--white);
  79 |   --warning-background: #ffe900;
  80 |   --warning-text: var(--black);
  81 |   --error-background: #d70022;
  82 |   --error-text: var(--white);
  83 |   --helpful-background: #00c8d7;
  84 |   --helpful-text: var(--black);
  85 |   --codeblock-background: var(--grey-2);
  86 |   --codeblock-border: var(--grey-4);
  87 |   --codeblock-text: var(--grey-6);
  88 |   --inline-code-background: var(--grey-3);
  89 |   --xref-code-background: transparent;
  90 |   --api-entry-background: var(--grey-2);
  91 |   --table-header-background: var(--grey-3);
  92 |   --table-text: var(--black);
  93 |   --table-border: var(--grey-4);
  94 |   --mobile-active-toc: var(--grey-7);
  95 |   --active-toc: var(--grey-3);
  96 |   --scrollbar: rgba(0,0,0,0.2);
  97 |   --scrollbar-hover: rgba(0,0,0,0.4);
  98 |   --rtd-ad-border: var(--grey-3);
  99 |   --rtd-ad-background: var(--grey-2);
 100 |   --rtd-ad-main-text: var(--grey-6);
 101 |   --rtd-ad-small-text: var(--grey-4);
 102 |   --rtd-version-background: #272525;
 103 |   --rtd-version-main-text: #fcfcfc;
 104 |   --attribute-table-title: var(--grey-6);
 105 |   --attribute-table-entry-border: var(--grey-3);
 106 |   --attribute-table-entry-text: var(--grey-5);
 107 |   --attribute-table-entry-hover-border: var(--blue-2);
 108 |   --attribute-table-entry-hover-background: var(--grey-2);
 109 |   --attribute-table-entry-hover-text: var(--blue-2);
 110 |   --attribute-table-badge: var(--grey-7);
 111 |   --highlighted-text: rgb(252, 233, 103);
 112 | }
 113 | 
 114 | :root[data-font="serif"] {
 115 |   --font-family: 'Georgia', 'Yu Gothic', 'Noto Sans CJK JP Regular', serif;
 116 | }
 117 | 
 118 | :root[data-theme="dark"] {
 119 |   --main-background: var(--grey-7);
 120 |   --link-text: var(--blue-1);
 121 |   --link-hover-text: var(--blue-2);
 122 |   --main-text: var(--white);
 123 |   --sub-header-background: var(--grey-8);
 124 |   --search-border: var(--grey-5);
 125 |   --nav-background: var(--main-background);
 126 |   --nav-text: var(--grey-1);
 127 |   --nav-hover-text: var(--grey-2);
 128 |   --nav-header-text: var(--white);
 129 |   --footer-text: var(--grey-2);
 130 |   --footer-link: var(--grey-1);
 131 |   --hr-border: var(--grey-1);
 132 |   --main-big-headers-text: var(--grey-1);
 133 |   --main-big-headers-border: var(--grey-1);
 134 |   --main-h5-header-text: var(--grey-4);
 135 |   --main-h6-header-text: var(--grey-5);
 136 |   --main-h4-header-border: var(--grey-2);
 137 |   --header-link: var(--grey-2);
 138 |   --header-link-hover-text: var(--grey-6);
 139 |   --admonition-background: var(--grey-8);
 140 |   --note-background: var(--blue-3);
 141 |   --note-text: var(--white);
 142 |   --warning-background: #d7b600;
 143 |   --warning-text: var(--black);
 144 |   --error-background:  #d70022;
 145 |   --error-text: var(--white);
 146 |   --helpful-background: #008ea4;
 147 |   --helpful-text: var(--white);
 148 |   --codeblock-background: var(--grey-6);
 149 |   --codeblock-border: var(--black);
 150 |   --codeblock-text: var(--grey-1);
 151 |   --inline-code-background: var(--grey-8);
 152 |   --xref-code-background: transparent;
 153 |   --api-entry-background: var(--grey-6);
 154 |   --table-header-background: var(--grey-6);
 155 |   --table-text: var(--grey-1);
 156 |   --table-border: var(--grey-4);
 157 |   --active-toc: var(--grey-6);
 158 |   --scrollbar: rgba(0,0,0,0.5);
 159 |   --scrollbar-hover: rgba(0,0,0,0.7);
 160 |   --rtd-ad-border: var(--grey-6);
 161 |   --rtd-ad-background: var(--grey-5);
 162 |   --rtd-ad-main-text: var(--grey-2);
 163 |   --rtd-ad-small-text: var(--grey-1);
 164 |   --attribute-table-title: var(--grey-3);
 165 |   --attribute-table-entry-border: var(--grey-5);
 166 |   --attribute-table-entry-text: var(--grey-3);
 167 |   --attribute-table-entry-hover-border: var(--blue-1);
 168 |   --attribute-table-entry-hover-background: var(--grey-6);
 169 |   --attribute-table-entry-hover-text: var(--blue-1);
 170 |   --attribute-table-badge: var(--grey-4);
 171 |   --highlighted-text: rgba(250, 166, 26, 0.2);
 172 |   --search-sidebar-background: var(--grey-7);
 173 |   --search-sidebar-text: var(--search-text);
 174 | }
 175 | 
 176 | img[src$="snake_dark.svg"]  {
 177 |   display: none;
 178 | }
 179 | :root[data-theme="dark"] img[src$="snake.svg"] {
 180 |   display: none;
 181 | }
 182 | :root[data-theme="dark"] img[src$="snake_dark.svg"] {
 183 |   display: inherit;
 184 | }
 185 | 
 186 | body {
 187 |   font-family: var(--font-family);
 188 |   font-size: 16px;
 189 |   margin: 0;
 190 |   padding: 0;
 191 |   height: 100%;
 192 |   background-color: var(--main-background);
 193 |   color: var(--main-text);
 194 | }
 195 | 
 196 | 
 197 | /* Scrollbar related */
 198 | 
 199 | #sidebar::-webkit-scrollbar {
 200 |   width: 0.5em;
 201 | }
 202 | 
 203 | #sidebar::-webkit-scrollbar-thumb {
 204 |   background-color: var(--scrollbar);
 205 |   border-radius: 0.25em;
 206 | }
 207 | 
 208 | #sidebar::-webkit-scrollbar-thumb:hover {
 209 |   background-color: var(--scrollbar-hover);
 210 | }
 211 | 
 212 | 
 213 | /* grid related */
 214 | 
 215 | .main-grid {
 216 |   display: grid;
 217 |   min-height: 100%;
 218 |   grid-auto-rows: min-content auto min-content;
 219 |   grid-template-areas:
 220 |     "s"
 221 |     "h"
 222 |     "n"
 223 |     "c"
 224 |     "f";
 225 | }
 226 | 
 227 | .grid-item {
 228 |   max-width: 100vw;
 229 |   padding: 0.8em;
 230 | }
 231 | 
 232 | /* all URLs only show underline on hover */
 233 | a {
 234 |   text-decoration: none;
 235 |   color: var(--link-text);
 236 | }
 237 | 
 238 | a:hover {
 239 |   text-decoration: underline;
 240 |   color: var(--link-hover-text);
 241 | }
 242 | 
 243 | /* headers */
 244 | 
 245 | header.grid-item {
 246 |   grid-area: h;
 247 |   color: var(--main-text);
 248 |   position: relative;
 249 |   z-index: 1;
 250 |   padding: 0;
 251 | }
 252 | 
 253 | header > nav {
 254 |   background-color: var(--sub-header-background);
 255 |   padding: 0.8em;
 256 |   display: flex;
 257 |   flex-direction: row;
 258 |   justify-content: flex-end;
 259 |   align-items: center;
 260 | }
 261 | 
 262 | header > nav a {
 263 |   color: var(--white);
 264 | }
 265 | 
 266 | header > nav.mobile-only {
 267 |   width: 100%;
 268 |   position: absolute;
 269 |   top: 0;
 270 |   right: 0;
 271 |   z-index: -1;
 272 |   padding-top: 0;
 273 |   transition: top 0.5s ease-in-out;
 274 | }
 275 | 
 276 | header > nav.mobile-only .search {
 277 |   width: 100%;
 278 | }
 279 | 
 280 | header > nav.mobile-only .search-wrapper {
 281 |   background-color: var(--sub-header-background);
 282 | }
 283 | 
 284 | .main-heading {
 285 |   margin-right: auto;
 286 | }
 287 | 
 288 | header > nav a:not(.main-heading) {
 289 |   margin: 0 0.5em;
 290 | }
 291 | 
 292 | header > nav > a:hover {
 293 |   color: var(--grey-1-8);
 294 |   text-decoration: underline;
 295 | }
 296 | 
 297 | .sub-header {
 298 |   grid-area: n;
 299 |   background-color: var(--sub-header-background);
 300 |   color: var(--white);
 301 |   display: none;
 302 | }
 303 | 
 304 | /* these aren't shown on mobile */
 305 | 
 306 | .sub-header > label {
 307 |   display: none;
 308 |   margin-right: 1em;
 309 | }
 310 | 
 311 | .sub-header > select {
 312 |   display: none;
 313 |   background-color: transparent;
 314 |   padding: 0.4em 0;
 315 |   font-size: 1em;
 316 |   width: 13.5%;
 317 |   color: white;
 318 |   border: none;
 319 |   border-bottom: 1px solid var(--search-border);
 320 | 
 321 |   appearance: none;
 322 |   background-image: url('/_images/drop_down_icon.svg');
 323 |   background-repeat: no-repeat;
 324 |   background-position-x: 100%;
 325 |   background-position-y: 50%;
 326 | 
 327 |   cursor: pointer;
 328 | }
 329 | 
 330 | .sub-header option {
 331 |     color: black;
 332 | }
 333 | 
 334 | .sub-header > select:focus {
 335 |   outline: none;
 336 | }
 337 | 
 338 | .sub-header > .settings {
 339 |   color: var(--settings);
 340 |   display: none;
 341 |   margin-left: 1em;
 342 |   margin-right: 0.5em;
 343 | }
 344 | 
 345 | .setting h3 {
 346 |   display: inline-block;
 347 |   margin-left: 2em;
 348 | }
 349 | 
 350 | .sub-header > .settings:hover {
 351 |   color: var(--settings-hover);
 352 | }
 353 | 
 354 | /* footer stuff */
 355 | footer {
 356 |   grid-area: f;
 357 |   font-size: 14px;
 358 |   text-align: right;
 359 |   color: var(--footer-text);
 360 | }
 361 | 
 362 | footer a {
 363 |   text-decoration: underline;
 364 |   color: var(--footer-link);
 365 | }
 366 | 
 367 | /* sidebar stuff */
 368 | 
 369 | aside {
 370 |   grid-area: s;
 371 |   font-size: 14px;
 372 |   line-height: 1.75em;
 373 |   top: 0;
 374 |   position: -webkit-sticky; /* safari */
 375 |   position: sticky;
 376 |   background-color: var(--mobile-nav-background);
 377 |   color: var(--mobile-nav-text);
 378 |   z-index: 2;
 379 |   max-height: 100vh;
 380 |   overflow-y: auto;
 381 |   overscroll-behavior-y: contain;
 382 | }
 383 | 
 384 | aside h3 {
 385 |   color: var(--mobile-nav-header-text);
 386 |   font-size: 24px;
 387 |   font-weight: normal;
 388 | }
 389 | 
 390 | .collapsible-arrow {
 391 |   font-size: 1.5em!important;
 392 |   left: -1.166em;
 393 |   top: 0.25em;
 394 |   user-select: none;
 395 |   position: relative;
 396 |   line-height: 0.5em;
 397 |   transition: transform 0.4s;
 398 |   transform: rotate(-90deg);
 399 | }
 400 | 
 401 | .expanded {
 402 |   transition: transform 0.4s;
 403 |   transform: rotate(0deg);
 404 | }
 405 | 
 406 | .ref-internal-padding {
 407 |   position: relative;
 408 |   left: -20px;
 409 | }
 410 | 
 411 | #settings-toggle {
 412 |   float: right;
 413 | }
 414 | 
 415 | aside .material-icons,
 416 | .settings > .material-icons {
 417 |   cursor: pointer;
 418 |   font-size: 2em;
 419 | }
 420 | 
 421 | .sidebar-toggle {
 422 |   display: unset !important;
 423 | }
 424 | 
 425 | #sidebar {
 426 |   display: none;
 427 | }
 428 | 
 429 | #sidebar a {
 430 |   color: var(--mobile-nav-text);
 431 | }
 432 | 
 433 | #sidebar a:hover {
 434 |   color: var(--mobile-nav-hover-text);
 435 | }
 436 | 
 437 | #sidebar h3 {
 438 |   font-size: 24px;
 439 |   margin: 1em 1em 0 0;
 440 | }
 441 | 
 442 | #sidebar ul {
 443 |   list-style: none;
 444 |   margin: 1em 2em 2em 1em;
 445 |   padding: 0;
 446 | }
 447 | 
 448 | #sidebar ul ul {
 449 |   list-style: square;
 450 |   margin: 0em;
 451 |   margin-left: 1.5em;
 452 | }
 453 | 
 454 | #sidebar li.no-list-style {
 455 |   list-style: none;
 456 | }
 457 | 
 458 | #sidebar form {
 459 |   margin: 1em 0;
 460 |   display: flex;
 461 |   align-items: baseline;
 462 | }
 463 | 
 464 | /* search button stuff */
 465 | 
 466 | .search-wrapper {
 467 |   display: flex;
 468 |   align-items: stretch;
 469 | }
 470 | 
 471 | .search-wrapper > input[type=search] {
 472 |   font-family: "Roboto", Corbel, Avenir, "Lucida Grande", "Lucida Sans", sans-serif;
 473 |   outline: none;
 474 |   appearance: none;
 475 |   font-size: 1em;
 476 | }
 477 | 
 478 | .search-wrapper > input[type=search],
 479 | .search-wrapper > button[type=submit] {
 480 |   background-color: var(--sub-header-background);
 481 |   border: none;
 482 |   color: var(--search-text);
 483 |   padding: 0.5em;
 484 |   min-height: 2.5em;
 485 |   flex: 9;
 486 | }
 487 | 
 488 | .search-wrapper {
 489 |   border-bottom: 1px solid var(--search-border);
 490 | }
 491 | 
 492 | .search-wrapper:focus-within {
 493 |   border-bottom: 1px solid var(--search-focus);
 494 | }
 495 | 
 496 | /* .search-wrapper > input[type=search] {
 497 |   border: 1px solid var(--search-border);
 498 |   border-right: none;
 499 |   border-top-left-radius: 4px;
 500 |   border-bottom-left-radius: 4px;
 501 | }
 502 | 
 503 | .search-wrapper > input[type=search]:focus,
 504 | button[type=submit]:focus ~ input[type=search] {
 505 |   border: 1px solid var(--search-focus);
 506 |   border-right: none;
 507 | } */
 508 | 
 509 | .search-wrapper > button[type=submit] {
 510 |   color: var(--search-button);
 511 |   /* border: 1px solid var(--search-border); */
 512 |   /* border-left: none; */
 513 |   /* border-bottom-right-radius: 4px; */
 514 |   /* border-top-right-radius: 4px; */
 515 |   cursor: pointer;
 516 |   flex: 1;
 517 | }
 518 | 
 519 | /* .search-wrapper > button[type=submit]:focus,
 520 | input[type=search]:focus ~ button[type=submit] {
 521 |   border: 1px solid var(--search-focus);
 522 |   border-left: none;
 523 | } */
 524 | 
 525 | .search-wrapper > button[type=submit]:hover {
 526 |   background-color: var(--search-border);
 527 |   color: var(--search-button-hover);
 528 | }
 529 | 
 530 | /* search sidebar */
 531 | 
 532 | .search-sidebar > input[type=search],
 533 | .search-sidebar > button[type=submit] {
 534 |   background-color: var(--search-sidebar-background);
 535 |   color: var(--search-sidebar-text);
 536 | }
 537 | 
 538 | .sidebar-toggle .search-sidebar > input[type=search],
 539 | .sidebar-toggle .search-sidebar > button[type=submit] {
 540 |   background-color: var(--mobile-nav-background);
 541 |   color: var(--mobile-nav-text);
 542 | }
 543 | 
 544 | /* main content area */
 545 | 
 546 | main {
 547 |   grid-area: c;
 548 | }
 549 | 
 550 | p {
 551 |   margin-bottom: 8px;
 552 | }
 553 | 
 554 | /* modal stuff */
 555 | 
 556 | div.modal {
 557 |   position: fixed;
 558 |   z-index: 10;
 559 |   left: 0;
 560 |   top: 0;
 561 |   width: 100%;
 562 |   height: 100%;
 563 |   overflow: hidden;
 564 |   background-color: rgba(0,0,0,0.4);
 565 |   cursor: pointer;
 566 |   display: none;
 567 | }
 568 | 
 569 | div.modal-content {
 570 |   background-color: var(--main-background);
 571 |   box-shadow: 0 2px 8px rgba(0,0,0,0.54);
 572 |   padding: 24px;
 573 |   border-radius: 4px;
 574 |   max-width: 40%;
 575 |   min-width: 350px;
 576 |   cursor: initial;
 577 |   flex: 1;
 578 |   margin: auto;
 579 | }
 580 | 
 581 | div.modal-content > span.close {
 582 |   color: #888;
 583 |   float: right;
 584 |   font-weight: bold;
 585 |   -moz-user-select: none;
 586 |   -webkit-user-select: none;
 587 |   cursor: pointer;
 588 | }
 589 | 
 590 | div.modal-content > span.close:hover,
 591 | div.modal-content > span.close:focus {
 592 |   color: #444;
 593 | }
 594 | 
 595 | div.modal input {
 596 |   cursor: pointer;
 597 | }
 598 | 
 599 | /* scroll to top button */
 600 | 
 601 | #to-top {
 602 |   position: fixed;
 603 |   bottom: 50px;
 604 |   right: 20px;
 605 | 
 606 |   cursor: pointer;
 607 | }
 608 | 
 609 | #to-top.is-rtd {
 610 |   bottom: 90px;
 611 | }
 612 | 
 613 | #to-top > span {
 614 |   display: block;
 615 | 
 616 |   width: auto;
 617 |   height: 30px;
 618 |   padding: 0 6px;
 619 | 
 620 |   background-color: var(--rtd-version-background);
 621 |   color: var(--rtd-version-main-text);
 622 | }
 623 | 
 624 | #to-top span {
 625 |   line-height: 30px;
 626 |   font-size: 90%;
 627 |   text-align: center;
 628 | }
 629 | 
 630 | /* copy button */
 631 | 
 632 | .relative-copy {
 633 |   position: relative;
 634 | }
 635 | 
 636 | .copy {
 637 |   cursor: pointer;
 638 |   position: absolute;
 639 |   top: 0px;
 640 |   right: 0px;
 641 |   border: 1px solid var(--codeblock-border);
 642 |   font-size: 0.875em;
 643 |   padding: 0.2em 0.5em;
 644 |   border-bottom-left-radius: 4px;
 645 |   display: flex;
 646 | }
 647 | 
 648 | /* -- body styles --------------------------------------------------------- */
 649 | 
 650 | hr {
 651 |   border: 1px solid var(--hr-border);
 652 | }
 653 | 
 654 | main h1,
 655 | main h2,
 656 | main h3,
 657 | main h4,
 658 | main h5,
 659 | main h6 { font-weight: normal; }
 660 | 
 661 | main h1,
 662 | main h2,
 663 | main h3,
 664 | main h4 { color: var(--main-big-headers-text); }
 665 | main h5 { color: var(--main-h5-header-text); }
 666 | main h6 { color: var(--main-h6-header-text); }
 667 | 
 668 | main h1 { margin: 0 0 10px 0; }
 669 | main h2,
 670 | main h3 { margin: 10px 0px 10px 0px; }
 671 | main h4,
 672 | main h5,
 673 | main h6 { margin: 20px 0px 10px 0px; }
 674 | 
 675 | main h1 { padding: 0 0 10px 0; }
 676 | main h2,
 677 | main h3 { padding: 10px 0 10px 0; }
 678 | main h4 { padding: 10px 0 10px 0; }
 679 | main h5,
 680 | main h6 { padding: 10px 0 0 0; }
 681 | 
 682 | main h1,
 683 | main h2,
 684 | main h3 { border-bottom: 1px solid var(--main-big-headers-border); }
 685 | main h4 { border-bottom: 1px solid var(--main-h4-header-border); }
 686 | 
 687 | main h1 { font-size: 2.3em; }
 688 | main h2 { font-size: 1.8em; }
 689 | main h3 { font-size: 1.3em; }
 690 | main h4 { font-size: 1.1em; }
 691 | main h5 { font-size: 1.05em; }
 692 | main h6 { font-size: 1em; }
 693 | 
 694 | a.headerlink {
 695 |   color: var(--header-link);
 696 |   font-size: 0.8em;
 697 |   padding: 0 4px 0 4px;
 698 |   text-decoration: none;
 699 |   visibility: hidden;
 700 | }
 701 | 
 702 | a.headerlink:hover {
 703 |   background-color: var(--header-link);
 704 |   color: var(--header-link-hover-text);
 705 | }
 706 | 
 707 | h1:hover > a.headerlink,
 708 | h2:hover > a.headerlink,
 709 | h3:hover > a.headerlink,
 710 | h4:hover > a.headerlink,
 711 | h5:hover > a.headerlink,
 712 | h6:hover > a.headerlink,
 713 | dt:hover > a.headerlink,
 714 | caption:hover > a.headerlink,
 715 | p.caption:hover > a.headerlink,
 716 | div.code-block-caption:hover > a.headerlink {
 717 |     visibility: visible;
 718 | }
 719 | 
 720 | .versionmodified {
 721 |   font-style: italic;
 722 | }
 723 | 
 724 | main ul {
 725 |   list-style: disc;
 726 |   margin: 1em 0;
 727 |   padding-left: 1.3em;
 728 | }
 729 | 
 730 | main ul ul, main ol ul {
 731 |   margin: .2em 0;
 732 |   padding-left: 1.2em;
 733 | }
 734 | 
 735 | main ul li {
 736 |   padding: 2px 0;
 737 | }
 738 | 
 739 | main ul.search li {
 740 |   padding: 5px 0 5px 20px;
 741 | }
 742 | 
 743 | main ol {
 744 |   counter-reset: li;
 745 |   margin-left: 0;
 746 |   padding-left: 0;
 747 | }
 748 | 
 749 | main ol ol {
 750 |   margin: .2em 0;
 751 | }
 752 | 
 753 | main ol > li {
 754 |   list-style: none;
 755 |   margin: 0 0 0 1.9em;
 756 |   padding: 2px 1px;
 757 |   position: relative;
 758 | }
 759 | 
 760 | main ol > li::before {
 761 |   content: counter(li) ".";
 762 |   counter-increment: li;
 763 |   top: -2px;
 764 |   left: -1.1em;
 765 |   width: 1.1em;
 766 |   padding: 4px 0;
 767 |   position: absolute;
 768 |   text-align: left;
 769 | }
 770 | 
 771 | main p,
 772 | main dd,
 773 | main li {
 774 |   line-height: 1.4;
 775 | }
 776 | 
 777 | main img {
 778 |   width: 100%;
 779 |   max-width: 500px;
 780 | }
 781 | 
 782 | /* weird margins */
 783 | li > p {
 784 |   margin: 2px;
 785 | }
 786 | 
 787 | li > blockquote {
 788 |   margin: 10px;
 789 | }
 790 | 
 791 | /* admonitions */
 792 | div.admonition {
 793 |   padding: 0 0.8em 0.8em 0.8em !important;
 794 |   margin: 0.8em 0;
 795 |   border-radius: 2.5px;
 796 |   border-left-width: 6px;
 797 |   border-left-style: solid;
 798 |   background-color: var(--admonition-background);
 799 | }
 800 | 
 801 | p.admonition-title {
 802 |   font-weight: bold;
 803 |   margin: 0 -0.8rem !important;
 804 |   padding: 0.4rem 0.6rem 0.4rem 2.5rem;
 805 |   position: relative;
 806 |   -moz-user-select: none;
 807 |   -webkit-user-select: none;
 808 |   -ms-user-select: none;
 809 |   user-select: none;
 810 | }
 811 | 
 812 | p.admonition-title::before {
 813 |   font: normal normal normal 24px/1 'Material Icons';
 814 |   display: inline-block;
 815 |   width: 24px;
 816 |   height: 24px;
 817 |   position: absolute;
 818 |   left: 9.6px;
 819 | }
 820 | 
 821 | div.important, div.note, div.hint, div.tip {
 822 |   border-left-color: var(--note-background);
 823 | }
 824 | 
 825 | div.important > p.admonition-title,
 826 | div.note > p.admonition-title,
 827 | div.hint > p.admonition-title,
 828 | div.tip > p.admonition-title {
 829 |   background-color: var(--note-background);
 830 |   color: var(--note-text);
 831 | }
 832 | 
 833 | div.important > p.admonition-title::before,
 834 | div.note > p.admonition-title::before,
 835 | div.hint > p.admonition-title::before,
 836 | div.tip > p.admonition-title::before {
 837 |   content: '\0e88e';
 838 | }
 839 | 
 840 | div.attention, div.warning, div.caution {
 841 |   border-left-color: var(--warning-background);
 842 | }
 843 | 
 844 | div.attention > p.admonition-title,
 845 | div.warning > p.admonition-title,
 846 | div.caution > p.admonition-title {
 847 |   background-color: var(--warning-background);
 848 |   color: var(--warning-text);
 849 | }
 850 | 
 851 | div.attention > p.admonition-title::before,
 852 | div.warning > p.admonition-title::before,
 853 | div.caution > p.admonition-title::before {
 854 |   content: '\0e002';
 855 | }
 856 | 
 857 | div.danger, div.error {
 858 |   border-left-color: var(--error-background);
 859 | }
 860 | 
 861 | div.danger > p.admonition-title,
 862 | div.error > p.admonition-title {
 863 |   background-color: var(--error-background);
 864 |   color: var(--error-text);
 865 | }
 866 | 
 867 | div.danger > p.admonition-title::before,
 868 | div.error > p.admonition-title::before {
 869 |   content: '\0e000';
 870 | }
 871 | 
 872 | /* helpful admonitions */
 873 | div.helpful {
 874 |   border-left-color: var(--helpful-background);
 875 | }
 876 | 
 877 | div.helpful > p.admonition-title {
 878 |   background-color: var(--helpful-background);
 879 |   color: var(--helpful-text);
 880 | }
 881 | 
 882 | div.helpful > p.admonition-title::before {
 883 |   content: '\0e873';
 884 | }
 885 | 
 886 | dl.field-list > dd {
 887 |   margin-top: 3px;
 888 |   margin-bottom: 10px;
 889 |   margin-left: 20px;
 890 | }
 891 | 
 892 | /* no disgusting background in the FAQ */
 893 | div.topic {
 894 |   background-color: transparent;
 895 |   border: none;
 896 | }
 897 | 
 898 | /* don't link-ify the FAQ page */
 899 | a.toc-backref {
 900 |   text-decoration: none;
 901 |   color: var(--main-text);
 902 | }
 903 | 
 904 | /* bold and fix the Parameter, Raises, etc. */
 905 | dl.field-list > dt {
 906 |   font-weight: bold;
 907 | }
 908 | 
 909 | /* remove flex from field lists */
 910 | dl.field-list {
 911 |   display: block;
 912 | }
 913 | 
 914 | /* cross-references are forced to bold for some reason */
 915 | a.reference > strong {
 916 |   font-weight: unset;
 917 |   font-family: var(--monospace-font-family);
 918 | }
 919 | a.reference.pep > strong,
 920 | a.reference.rfc > strong {
 921 |   font-family: inherit;
 922 | }
 923 | 
 924 | /* exception hierarchy */
 925 | 
 926 | .exception-hierarchy-content dd,
 927 | .exception-hierarchy-content dl {
 928 |   margin: 0px 2px;
 929 | }
 930 | 
 931 | .exception-hierarchy-content {
 932 |   margin-left: 0.5em;
 933 | }
 934 | 
 935 | .exception-hierarchy-content ul {
 936 |   list-style: '»' !important;
 937 | }
 938 | 
 939 | /* attribute tables */
 940 | .py-attribute-table {
 941 |   display: flex;
 942 |   flex-wrap: wrap;
 943 |   flex-direction: row;
 944 |   margin: 0 2em;
 945 |   padding-top: 16px;
 946 | }
 947 | 
 948 | .py-attribute-table-column {
 949 |   flex: 1 1 auto;
 950 | }
 951 | 
 952 | .py-attribute-table-column:not(:first-child) {
 953 |   margin-top: 1em;
 954 | }
 955 | 
 956 | .py-attribute-table-column > span {
 957 |   font-weight: bold;
 958 |   color: var(--attribute-table-title);
 959 | }
 960 | 
 961 | main .py-attribute-table-column > ul {
 962 |   list-style: none;
 963 |   margin: 4px 0px;
 964 |   padding-left: 0;
 965 |   font-size: 0.95em;
 966 | }
 967 | 
 968 | .py-attribute-table-entry {
 969 |   margin: 0;
 970 |   padding: 2px 0;
 971 |   padding-left: 0.2em;
 972 |   border-left: 2px solid var(--attribute-table-entry-border);
 973 |   display: flex;
 974 |   line-height: 1.2em;
 975 | }
 976 | 
 977 | .py-attribute-table-entry > a {
 978 |   padding-left: 0.5em;
 979 |   color: var(--attribute-table-entry-text);
 980 |   flex-grow: 1;
 981 | }
 982 | 
 983 | .py-attribute-table-entry > a:hover {
 984 |   color: var(--attribute-table-entry-hover-text);
 985 |   text-decoration: none;
 986 | }
 987 | 
 988 | .py-attribute-table-entry:hover {
 989 |   background-color: var(--attribute-table-entry-hover-background);
 990 |   border-left: 2px solid var(--attribute-table-entry-hover-border);
 991 |   text-decoration: none;
 992 | }
 993 | 
 994 | .py-attribute-table-badge {
 995 |   flex-basis: 3em;
 996 |   text-align: right;
 997 |   font-size: 0.9em;
 998 |   color: var(--attribute-table-badge);
 999 |   -moz-user-select: none;
1000 |   -webkit-user-select: none;
1001 |   user-select: none;
1002 | }
1003 | 
1004 | pre {
1005 |   background-color: var(--codeblock-background);
1006 |   border: 1px solid var(--codeblock-border);
1007 |   color: var(--codeblock-text);
1008 |   font-size: 0.75em;
1009 |   line-height: 1.5em;
1010 |   margin: 1.5em 0 1.5em 0;
1011 |   padding: 10px;
1012 |   overflow-x: auto;
1013 | }
1014 | 
1015 | pre, code {
1016 |   font-family: var(--monospace-font-family);
1017 |   font-size: 0.9em;
1018 |   overflow-wrap: break-word;
1019 | }
1020 | 
1021 | code {
1022 |   background-color: var(--inline-code-background);
1023 |   padding: .15em;
1024 |   border-radius: 3px;
1025 | }
1026 | 
1027 | code.descname {
1028 |   background-color: transparent;
1029 |   font-weight: bold;
1030 |   font-size: 0.95em;
1031 | }
1032 | 
1033 | code.descclassname {
1034 |   background-color: transparent;
1035 |   padding-right: 0;
1036 | }
1037 | 
1038 | code.descclassname + code.descname {
1039 |   padding-left: 0;
1040 | }
1041 | 
1042 | code.xref, a code {
1043 |   font-weight: normal;
1044 |   background-color: var(--xref-code-background);
1045 | }
1046 | 
1047 | span.pre {
1048 |   padding: 0 2px;
1049 | }
1050 | 
1051 | dl.class {
1052 |   margin-bottom: 50px;
1053 | }
1054 | 
1055 | dl.data > dt,
1056 | dl.describe > dt,
1057 | dl.function > dt,
1058 | dl.attribute > dt,
1059 | dl.classmethod > dt,
1060 | dl.method > dt,
1061 | dl.property > dt,
1062 | dl.class > dt,
1063 | dl.exception > dt {
1064 |   background-color: var(--api-entry-background);
1065 |   padding: 1px 10px;
1066 | }
1067 | 
1068 | /* bug in sphinx: https://github.com/sphinx-doc/sphinx/issues/9384 */
1069 | dl.property > dt > span.descname + em.property {
1070 |   display: none;
1071 | }
1072 | 
1073 | dd {
1074 |   margin-top: 0.5em;
1075 |   margin-bottom: 0.5em;
1076 |   margin-left: 1.5em;
1077 | }
1078 | 
1079 | dt:target, span.highlighted {
1080 |     background-color: var(--highlighted-text);
1081 | }
1082 | 
1083 | rect.highlighted {
1084 |     fill: var(--highlighted-text);
1085 | }
1086 | 
1087 | .container.operations {
1088 |   padding: 10px;
1089 |   border: 1px solid var(--codeblock-border);
1090 |   margin-bottom: 20px;
1091 | }
1092 | 
1093 | .container.operations::before {
1094 |   content: 'Supported Operations';
1095 |   color: var(--main-big-headers-text);
1096 |   display: block;
1097 |   padding-bottom: 0.5em;
1098 | }
1099 | 
1100 | .container.operations > dl.describe > dt {
1101 |   background-color: var(--api-entry-background);
1102 | }
1103 | 
1104 | .table-wrapper {
1105 |   overflow-x: auto;
1106 | }
1107 | 
1108 | table.docutils {
1109 |   width: 100%;
1110 |   border-collapse: collapse;
1111 | }
1112 | 
1113 | table.docutils.footnote {
1114 |   width: auto;
1115 | }
1116 | 
1117 | table.docutils thead,
1118 | table.docutils tfoot {
1119 |   background: var(--table-header-background);
1120 | }
1121 | 
1122 | table.docutils thead tr th {
1123 |   color: var(--table-text);
1124 |   font-weight: normal;
1125 |   padding: 7px 5px;
1126 |   vertical-align: middle;
1127 | }
1128 | 
1129 | table.docutils tbody tr th,
1130 | table.docutils tbody tr td {
1131 |   border-bottom: 0;
1132 |   padding: 7px 5px;
1133 |   vertical-align: top;
1134 | }
1135 | 
1136 | table.docutils tbody tr:not(:first-child) {
1137 |   border-top: solid 1px var(--table-border);
1138 | }
1139 | 
1140 | table.docutils tbody tr:last-child th,
1141 | table.docutils tbody tr:last-child td {
1142 |   border-bottom: solid 1px var(--table-border);
1143 | }
1144 | 
1145 | table.docutils thead tr td p,
1146 | table.docutils tfoot tr td p,
1147 | table.docutils tbody tr td p,
1148 | table.docutils thead tr td ul,
1149 | table.docutils tfoot tr td ul,
1150 | table.docutils tbody tr td ul,
1151 | table.docutils thead tr td ol,
1152 | table.docutils tfoot tr td ol,
1153 | table.docutils tbody tr td ol {
1154 |   margin: 0 0 .5em;
1155 | }
1156 | table.docutils thead tr td p.last,
1157 | table.docutils tfoot tr td p.last,
1158 | table.docutils tbody tr td p.last,
1159 | table.docutils thead tr td ul.last,
1160 | table.docutils tfoot tr td ul.last,
1161 | table.docutils tbody tr td ul.last,
1162 | table.docutils thead tr td ol.last,
1163 | table.docutils tfoot tr td ol.last,
1164 | table.docutils tbody tr td ol.last {
1165 |   margin-bottom: 0;
1166 | }
1167 | 
1168 | /* added when the `align` attribute is specified in the `image` directive */
1169 | main img.align-left {
1170 |   margin-left: .5em;
1171 | }
1172 | 
1173 | main img.align-right {
1174 |   margin-right: .5em;
1175 | }
1176 | 
1177 | .align-default {
1178 |   text-align: left !important;
1179 | }
1180 | 
1181 | /* hide the welcome text */
1182 | section#welcome-to-discord-py > h1 {
1183 |   display: none;
1184 | }
1185 | 
1186 | /* make the RTD ad look a little less jarring */
1187 | 
1188 | .ethical-fixedfooter {
1189 |   background-color: var(--rtd-ad-background) !important;
1190 |   border-top: 1px solid var(--rtd-ad-border) !important;
1191 | }
1192 | 
1193 | .ethical-fixedfooter a {
1194 |   color: var(--rtd-ad-main-text) !important;
1195 | }
1196 | 
1197 | .ethical-callout > small > em > a {
1198 |   color: var(--rtd-ad-small-text) !important;
1199 | }
1200 | 
1201 | .active {
1202 |   background-color: var(--mobile-active-toc);
1203 |   border-left: 5px solid var(--mobile-active-toc);
1204 | }
1205 | 
1206 | div.code-block-caption {
1207 |   font-size: medium;
1208 |   font-weight: bold;
1209 | }
1210 | 
1211 | 
1212 | /* desktop stuff */
1213 | 
1214 | @media screen and (min-width: 600px) {
1215 |   .grid-item {
1216 |     max-width: unset;
1217 |   }
1218 | 
1219 |   .main-grid {
1220 |     grid-template-areas:
1221 |       "h h h h h h"
1222 |       "n n n n n n"
1223 |       "s s c c c c"
1224 |       "s s f f f f";
1225 |   }
1226 | 
1227 |   .mobile-only {
1228 |     display: none;
1229 |   }
1230 | 
1231 |   header {
1232 |     background-color: var(--black);
1233 |   }
1234 | 
1235 |   header > nav {
1236 |     background-color: unset;
1237 |   }
1238 | 
1239 |   .sub-header {
1240 |     display: flex;
1241 |     align-items: center;
1242 |   }
1243 | 
1244 |   .sub-header > label {
1245 |     display: initial;
1246 |   }
1247 | 
1248 |   .sub-header > select {
1249 |     display: initial;
1250 |     margin-right: auto;
1251 |   }
1252 | 
1253 |   .sub-header > .settings {
1254 |     display: initial;
1255 |   }
1256 | 
1257 |   aside {
1258 |     top: initial;
1259 |     position: initial;
1260 |     background-color: var(--nav-background);
1261 |     color: var(--nav-text);
1262 |     max-height: unset;
1263 |     overflow-y: unset;
1264 |     overscroll-behavior-y: unset;
1265 |   }
1266 | 
1267 |   aside h3 {
1268 |     color: var(--nav-header-text);
1269 |   }
1270 | 
1271 |   #sidebar {
1272 |     display: inline-block;
1273 |     position: sticky;
1274 |     top: 1em;
1275 |     max-height: calc(100vh - 2em);
1276 |     overflow-y: auto;
1277 |     margin: 1em;
1278 |   }
1279 | 
1280 |   #sidebar a {
1281 |     color: var(--nav-text);
1282 |   }
1283 | 
1284 |   .active {
1285 |     background-color: transparent;
1286 |     border-left: none;
1287 |     position: relative;
1288 |   }
1289 | 
1290 |   .active::before {
1291 |     content: "";
1292 |     display: inline-block;
1293 |     background-color: var(--active-toc);
1294 |     position: absolute;
1295 |     top: 0;
1296 |     bottom: 0;
1297 |     right: 0;
1298 |     width: calc(100% + 0.5em);
1299 |     border-radius: 4px;
1300 |     z-index: -1;
1301 |   }
1302 | 
1303 |   #sidebar a:hover {
1304 |     color: var(--nav-hover-text);
1305 |   }
1306 | 
1307 |   #hamburger-toggle, #settings-toggle {
1308 |     display: none;
1309 | 
1310 |   }
1311 | }
1312 | 
1313 | @media screen and (min-width: 1200px) {
1314 |   .main-grid {
1315 |     /* 62.5% width => multiple of 5/8 content */
1316 |     /* sidebar takes up 20% of the inner area */
1317 |     grid-template-columns: repeat(16, 1fr);
1318 |     grid-template-areas:
1319 |       "h h h h h h h h h h h h h h h h"
1320 |       "n n n n n n n n n n n n n n n n"
1321 |       "s s s . . c c c c c c c c c . ."
1322 |       "s s s f f f f f f f f f f f f f"
1323 |   }
1324 | 
1325 |   header > nav {
1326 |     margin-left: 18.75%;
1327 |     margin-right: 18.75%;
1328 |   }
1329 | 
1330 |   .sub-header > label {
1331 |     margin-left: 18.75%;
1332 |     margin-right: 1em;
1333 |   }
1334 | 
1335 |   .sub-header > .settings {
1336 |     margin-right: 18.75%;
1337 |     margin-left: 1em;
1338 |   }
1339 | 
1340 |   .sub-header > .search {
1341 |     width: 20%;
1342 |   }
1343 | 
1344 |   .py-attribute-table-column:not(:first-child) {
1345 |     margin-top: unset;
1346 |   }
1347 | 
1348 |   main img {
1349 |     display: block;
1350 |     margin-left: auto;
1351 |     margin-right: auto;
1352 |   }
1353 | }
1354 | 


--------------------------------------------------------------------------------
/docs/_templates/genindex.html:
--------------------------------------------------------------------------------
 1 | {%- extends "basic/genindex.html" %}
 2 | 
 3 | {% block body %}
 4 |   {{ super() }}
 5 |   <!-- Inject some JavaScript to convert the index names into something useful. -->
 6 |   <script>
 7 |     let elements = document.querySelectorAll("table.indextable a");
 8 | 
 9 |     // this is pretty finicky but it should work.
10 |     for(let el of elements) {
11 |       let key = el.getAttribute('href').split('#', 2)[1]
12 |       if(!key.startsWith('discord.')) {
13 |         continue;
14 |       }
15 | 
16 |       if(key.startsWith('discord.ext.')) {
17 |         key = key.substr(12); // discord.ext.
18 |       }
19 | 
20 |       if(el.textContent.indexOf('()') !== -1) {
21 |         key = key + '()'
22 |       }
23 |       el.textContent = key;
24 |     }
25 |     document.querySelectorAll("td").forEach(el => el.style.width = 'auto');
26 |   </script>
27 | {% endblock %}
28 | 


--------------------------------------------------------------------------------
/docs/_templates/layout.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html>
  3 | <head>
  4 |   <meta charset="utf-8">
  5 |   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6 |   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
  7 |   {%- block extrahead %} {% endblock %}
  8 |   <!-- end extra head -->
  9 |   <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
 10 |   {%- block css %}
 11 |   {%- for css in css_files %}
 12 |     {%- if css|attr("filename") %}
 13 |   {{ css_tag(css) }}
 14 |     {%- else %}
 15 |   <link rel="stylesheet" href="{{ pathto(css, 1)|e }}" type="text/css" />
 16 |     {%- endif %}
 17 |   {%- endfor %}
 18 |   {%- endblock %}
 19 |   <link rel="stylesheet" href="{{ pathto('_static/style.css', 1)|e }}" type="text/css" />
 20 |   <link rel="stylesheet" href="{{ pathto('_static/codeblocks.css', 1) }}" type="text/css" />
 21 |   <link rel="stylesheet" href="{{ pathto('_static/icons.css', 1)|e }}" type="text/css" />
 22 |   {%- block scripts %}
 23 |   <script id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
 24 |   {%- for js in script_files %}
 25 |   {{ js_tag(js) }}
 26 |   {%- endfor %}
 27 |   {%- endblock %}
 28 |   {%- if pageurl %}
 29 |   <link rel="canonical" href="{{ pageurl|e }}" />
 30 |   {%- endif %}
 31 |   {%- if favicon %}
 32 |   <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1)|e }}"/>
 33 |   {%- endif %}
 34 |   {%- block linktags %}
 35 |   {%- if hasdoc('about') %}
 36 |   <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
 37 |   {%- endif %}
 38 |   {%- if hasdoc('genindex') %}
 39 |   <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
 40 |   {%- endif %}
 41 |   {%- if hasdoc('search') %}
 42 |   <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
 43 |   {%- endif %}
 44 |   {%- if hasdoc('copyright') %}
 45 |   <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
 46 |   {%- endif %}
 47 |   {%- if next %}
 48 |   <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
 49 |   {%- endif %}
 50 |   {%- if prev %}
 51 |   <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
 52 |   {%- endif %}
 53 |   {%- endblock %}
 54 | </head>
 55 | <body>
 56 | {%- block header %}{% endblock %}
 57 |   <div class="main-grid">
 58 |     {#- The main navigation header #}
 59 |     <header class="grid-item">
 60 |       <nav>
 61 |         <a href="{{ pathto(master_doc)|e }}" class="main-heading">Github-API-Wrapper</a>
 62 |         <a href="https://github.com/VarMonke/Github-API-Wrapper" title="GitHub"><span class="material-icons custom-icons">github</span></a>
 63 |         <a href="{{ discord_invite }}" title="{{ _('Discord') }}"><span class="material-icons custom-icons">discord</span></a>
 64 |         <a href="{{ pathto('faq') }}" title="FAQ"><span class="material-icons">help_center</span></a>
 65 |         {#- If we have more links we can put them here #}
 66 |         <a onclick="mobileSearch.open();" title="{{ _('Search') }}" id="open-search" class="mobile-only"><span class="material-icons">search</span></a>
 67 |         <a onclick="mobileSearch.close();" title="{{ _('Close') }}" id="close-search" class="mobile-only" hidden><span class="material-icons">close</span></a>
 68 |       </nav>
 69 |       <nav class="mobile-only">
 70 |         <form role="search" class="search" action="{{ pathto('search') }}" method="get">
 71 |           <div class="search-wrapper">
 72 |             <input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
 73 |             <button type="submit">
 74 |               <span class="material-icons">search</span>
 75 |             </button>
 76 |           </div>
 77 |         </form>
 78 |       </nav>
 79 |     </header>
 80 |     <div class="sub-header grid-item">
 81 |       <label for="documentation_select">{{ _('') }}</label>
 82 |     {#- The sub-header with search and extension related selection #}
 83 |       <form id="search-form" role="search" class="search" action="{{ pathto('search') }}" method="get">
 84 |         <div class="search-wrapper">
 85 |           <input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
 86 |           <button type="submit" onmousedown="searchBarClick(event, document.getElementById('search-form'));">
 87 |             <span class="material-icons">search</span>
 88 |           </button>
 89 |         </div>
 90 |       </form>
 91 |       <a accesskey="S" class="settings" onclick="settingsModal.open();"><span class="material-icons">settings</span></a>
 92 |     </div>
 93 |     {#- The sidebar component #}
 94 |     <aside class="grid-item">
 95 |       {%- if display_toc %}
 96 |       <span id="hamburger-toggle">
 97 |         <span class="material-icons">menu</span>
 98 |       </span>
 99 |       {%- endif %}
100 |       <span id="settings-toggle" class="settings" onclick="settingsModal.open();">
101 |         <span class="material-icons">settings</span>
102 |       </span>
103 |       <div id="sidebar">
104 |         <form id="sidebar-form" role="search" class="search" action="{{ pathto('search') }}" method="get">
105 |         <div class="search-wrapper search-sidebar">
106 |           <input type="search" name="q" placeholder="{{ _('Search documentation') }}" />
107 |           <button type="submit" onmousedown="searchBarClick(event, document.getElementById('sidebar-form'));">
108 |             <span class="material-icons">search</span>
109 |           </button>
110 |         </div>
111 |       </form>
112 |         {%- include "localtoc.html" %}
113 |       </div>
114 |     </aside>
115 |     {#- The actual body of the contents #}
116 |     <main class="grid-item" role="main">
117 |       {% block body %} {% endblock %}
118 |     </main>
119 | {%- block footer %}
120 |     <footer class="grid-item">
121 |     {%- if show_copyright %}
122 |       {%- if hasdoc('copyright') %}
123 |         {% trans path=pathto('copyright'), copyright=copyright|e %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
124 |       {%- else %}
125 |         {% trans copyright=copyright|e %}&#169; Copyright {{ copyright }}.{% endtrans %}
126 |       {%- endif %}
127 |     {%- endif %}
128 |     {%- if last_updated %}
129 |       {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
130 |     {%- endif %}
131 |     {%- if show_sphinx %}
132 |       {% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
133 |     {%- endif %}
134 |     </footer>
135 | {%- endblock %}
136 |   </div>
137 |   {%- if READTHEDOCS %}
138 |   <script>
139 |     if (typeof READTHEDOCS_DATA !== "undefined") {
140 |         if (!READTHEDOCS_DATA.features) {
141 |           READTHEDOCS_DATA.features = {};
142 |         }
143 |         READTHEDOCS_DATA.features.docsearch_disabled = true;
144 |       }
145 |   </script>
146 |   {%- endif %}
147 | 
148 |   <div id="settings" class="modal" onclick="if (event.target == this){ settingsModal.close(); }" hidden>
149 |     <div class="modal-content">
150 |       <span class="close" onclick="settingsModal.close();" title="Close">
151 |         <span class="material-icons">close</span>
152 |       </span>
153 |       <h1>{{ _('Settings') }}</h1>
154 | 
155 |       <h2>{{ _('Font') }}</h2>
156 |       <div class="setting">
157 |         <h3>{{ _('Use a serif font:') }}
158 |           <label class="toggle"
159 |             title="{{ _('Use a serif font? Your system font will be used, falling back to serif.')}}">
160 |             <input type="checkbox" name="useSerifFont" onclick="updateSetting(this);">
161 |             <span class="toggle-slider"></span>
162 |           </label>
163 |         </h3>
164 |       </div>
165 | 
166 |       <h2>{{ _('Theme') }}</h2>
167 |       <div class="setting">
168 |         <h3>
169 |           <label class="toggle" title="{{ _('Set your theme based on your system preferences') }}">
170 |             <input type="radio" name="setTheme" onclick="updateSetting(this);" value="automatic" checked>
171 |           </label>
172 |           {{ _('Automatic') }}
173 |         </h3>
174 |         <h3>
175 |           <label class="toggle" title="{{ _('Set your theme to light theme') }}">
176 |             <input type="radio" name="setTheme" onclick="updateSetting(this);" value="light">
177 |           </label>
178 |           {{ _('Light') }}
179 |         </h3>
180 |         <h3>
181 |           <label class="toggle" title="{{ _('Set your theme to dark theme') }}">
182 |             <input type="radio" name="setTheme" onclick="updateSetting(this);" value="dark">
183 |           </label>
184 |           {{ _('Dark') }}
185 |         </h3>
186 |       </div>
187 | 
188 |     </div>
189 |   </div>
190 | 
191 |   <div id="to-top" onclick="scrollToTop()"{%- if READTHEDOCS %} class="is-rtd"{%- endif %} hidden>
192 |     <span><span class="material-icons">arrow_upward</span> to top</span>
193 |   </div>
194 | 
195 | </body>
196 | </html>
197 | 


--------------------------------------------------------------------------------
/docs/_templates/relations.html:
--------------------------------------------------------------------------------
1 | <!-- purposefully empty -->
2 | 


--------------------------------------------------------------------------------
/docs/api.rst:
--------------------------------------------------------------------------------
 1 | API Reference
 2 | =============
 3 | 
 4 | .. currentmodule:: github
 5 | 
 6 | Client
 7 | ------
 8 | .. autoclass:: GHClient
 9 |     :members:
10 | 
11 | API Models
12 | ----------
13 | 
14 | APIObject
15 | ~~~~~~~~~
16 | .. autoclass:: APIObject()
17 |     :members:
18 | 
19 | User
20 | ~~~~
21 | .. autoclass:: User()
22 |     :members:
23 | 
24 | PartialUser
25 | ~~~~~~~~~~~
26 | .. autoclass:: PartialUser()
27 |     :members:
28 | 
29 | Repository
30 | ~~~~~~~~~~
31 | .. autoclass:: Repository()
32 |     :members:
33 | 
34 | Issue
35 | ~~~~~
36 | .. autoclass:: Issue()
37 |     :members:
38 | 
39 | File
40 | ~~~~
41 | .. autoclass:: File()
42 |     :members:
43 | 
44 | Gist
45 | ~~~~
46 | .. autoclass:: Gist()
47 |     :members:
48 | 
49 | Organization
50 | ~~~~~~~~~~~~
51 | .. autoclass:: Organization()
52 |     :members:


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | import logging
  2 | import os
  3 | import re
  4 | import sys
  5 | 
  6 | # If extensions (or modules to document with autodoc) are in another directory,
  7 | # add these directories to sys.path here. If the directory is relative to the
  8 | # documentation root, use os.path.abspath to make it absolute, like shown here.
  9 | sys.path.insert(0, os.path.abspath('..'))
 10 | sys.path.append(os.path.abspath('extensions'))
 11 | 
 12 | # -- General configuration ------------------------------------------------
 13 | 
 14 | # If your documentation needs a minimal Sphinx version, state it here.
 15 | # needs_sphinx = '1.0'
 16 | 
 17 | # Add any Sphinx extension module names here, as strings. They can be
 18 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 19 | # ones.
 20 | extensions = [
 21 |     'builder',
 22 |     'sphinx.ext.autodoc',
 23 |     'sphinx.ext.extlinks',
 24 |     'sphinx.ext.intersphinx',
 25 |     'sphinx.ext.napoleon',
 26 |     'sphinxcontrib_trio',
 27 |     'details',
 28 |     'exception_hierarchy',
 29 |     'attributetable',
 30 |     'resourcelinks',
 31 |     'nitpick_file_ignorer',
 32 | ]
 33 | 
 34 | autodoc_member_order = 'bysource'
 35 | autodoc_typehints = 'none'
 36 | # autodoc_mock_imports = ['sphinxcontrib_trio','sphinxcontrib-serializinghtml','sphinxcontrib-qthelp','sphinxcontrib-jsmath','sphinxcontrib-htmlhelp','sphinxcontrib-devhelp','sphinxcontrib-applehelp ','typing_extensions']
 37 | # maybe consider this?
 38 | # napoleon_attr_annotations = False
 39 | 
 40 | extlinks = {
 41 |     'issue': ('https://github.com/VarMonke/Github-Api-Wrapper/issues/%s', 'GH-'),
 42 | }
 43 | 
 44 | # Links used for cross-referencing stuff in other documentation
 45 | intersphinx_mapping = {
 46 |     'py': ('https://docs.python.org/3', None),
 47 |     'aio': ('https://docs.aiohttp.org/en/stable/', None),
 48 |     'req': ('https://docs.python-requests.org/en/latest/', None),
 49 | }
 50 | 
 51 | rst_prolog = """
 52 | .. |coro| replace:: This function is a |coroutine_link|_.
 53 | .. |maybecoro| replace:: This function *could be a* |coroutine_link|_.
 54 | .. |coroutine_link| replace:: *coroutine*
 55 | .. _coroutine_link: https://docs.python.org/3/library/asyncio-task.html#coroutine
 56 | """
 57 | 
 58 | # Add any paths that contain templates here, relative to this directory.
 59 | templates_path = ['_templates']
 60 | 
 61 | # The suffix of source filenames.
 62 | source_suffix = '.rst'
 63 | 
 64 | # The encoding of source files.
 65 | # source_encoding = 'utf-8-sig'
 66 | 
 67 | # The master toctree document.
 68 | master_doc = 'index'
 69 | 
 70 | # General information about the project.
 71 | project = 'Github-API-Wrapper'
 72 | copyright = '2022 - Present, VarMonke & sudosnok'
 73 | 
 74 | # The version info for the project you're documenting, acts as replacement for
 75 | # |version| and |release|, also used in various other places throughout the
 76 | # built documents.
 77 | #
 78 | # The short X.Y version.
 79 | 
 80 | version = ''
 81 | with open('../github/__init__.py') as f:
 82 |     version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1)  # type: ignore
 83 | 
 84 | # The full version, including alpha/beta/rc tags.
 85 | release = version
 86 | 
 87 | # This assumes a tag is available for final releases
 88 | branch = 'master' if version.endswith('a') else f"v{version}"
 89 | 
 90 | # The language for content autogenerated by Sphinx. Refer to documentation
 91 | # for a list of supported languages.
 92 | #
 93 | # This is also used if you do content translation via gettext catalogs.
 94 | # Usually you set "language" from the command line for these cases.
 95 | language = None
 96 | 
 97 | locale_dirs = ['locale/']
 98 | gettext_compact = False
 99 | 
100 | # There are two options for replacing |today|: either, you set today to some
101 | # non-false value, then it is used:
102 | # today = ''
103 | # Else, today_fmt is used as the format for a strftime call.
104 | # today_fmt = '%B %d, %Y'
105 | 
106 | # List of patterns, relative to source directory, that match files and
107 | # directories to ignore when looking for source files.
108 | exclude_patterns = ['_build']
109 | 
110 | # The reST default role (used for this markup: `text`) to use for all
111 | # documents.
112 | # default_role = None
113 | 
114 | # If true, '()' will be appended to :func: etc. cross-reference text.
115 | # add_function_parentheses = True
116 | 
117 | # If true, the current module name will be prepended to all description
118 | # unit titles (such as .. function::).
119 | # add_module_names = True
120 | 
121 | # If true, sectionauthor and moduleauthor directives will be shown in the
122 | # output. They are ignored by default.
123 | # show_authors = False
124 | 
125 | # The name of the Pygments (syntax highlighting) style to use.
126 | pygments_style = 'friendly'
127 | 
128 | # A list of ignored prefixes for module index sorting.
129 | # modindex_common_prefix = []
130 | 
131 | # If true, keep warnings as "system message" paragraphs in the built documents.
132 | # keep_warnings = False
133 | 
134 | 
135 | # Ignore warnings about inconsistent order and/or count of references in translated messages.
136 | # This makes no sense, different languages can have different word order...
137 | def _i18n_warning_filter(record: logging.LogRecord) -> bool:
138 |     return not record.msg.startswith(
139 |         (
140 |             'inconsistent references in translated message',
141 |             'inconsistent term references in translated message',
142 |         )
143 |     )
144 | 
145 | 
146 | _i18n_logger = logging.getLogger('sphinx')
147 | _i18n_logger.addFilter(_i18n_warning_filter)
148 | 
149 | # -- Options for HTML output ----------------------------------------------
150 | 
151 | html_experimental_html5_writer = True
152 | 
153 | # The theme to use for HTML and HTML Help pages.  See the documentation for
154 | # a list of builtin themes.
155 | html_theme = 'basic'
156 | 
157 | html_context = {
158 |     'discord_invite': 'https://discord.gg/r3sSKJJ',
159 |     'discord_extensions': [
160 |         ('discord.ext.commands', 'ext/commands'),
161 |         ('discord.ext.tasks', 'ext/tasks'),
162 |     ],
163 | }
164 | 
165 | resource_links = {
166 |     'discord': 'https://discord.gg/W2SDTtMrZA',
167 |     'issues': 'https://github.com/VarMonke/Github-Api-Wrapper/issues',
168 |     'discussions': 'https://github.com/VarMonke/Github-Api-Wrapper/discussions',
169 |     'examples': f'https://github.com/VarMonke/Github-Api-Wrapper/examples',
170 | }
171 | 
172 | # Theme options are theme-specific and customize the look and feel of a theme
173 | # further.  For a list of options available for each theme, see the
174 | # documentation.
175 | # html_theme_options = {
176 | # }
177 | 
178 | # Add any paths that contain custom themes here, relative to this directory.
179 | # html_theme_path = []
180 | 
181 | # The name for this set of Sphinx documents.  If None, it defaults to
182 | # "<project> v<release> documentation".
183 | # html_title = None
184 | 
185 | # A shorter title for the navigation bar.  Default is the same as html_title.
186 | # html_short_title = None
187 | 
188 | # The name of an image file (relative to this directory) to place at the top
189 | # of the sidebar.
190 | # html_logo = None
191 | 
192 | # The name of an image file (within the static path) to use as favicon of the
193 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
194 | # pixels large.
195 | html_favicon = './images/icon.ico'
196 | 
197 | # Add any paths that contain custom static files (such as style sheets) here,
198 | # relative to this directory. They are copied after the builtin static files,
199 | # so a file named "default.css" will overwrite the builtin "default.css".
200 | html_static_path = ['_static']
201 | 
202 | # Add any extra paths that contain custom files (such as robots.txt or
203 | # .htaccess) here, relative to this directory. These files are copied
204 | # directly to the root of the documentation.
205 | # html_extra_path = []
206 | 
207 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
208 | # using the given strftime format.
209 | # html_last_updated_fmt = '%b %d, %Y'
210 | 
211 | # If true, SmartyPants will be used to convert quotes and dashes to
212 | # typographically correct entities.
213 | # html_use_smartypants = True
214 | 
215 | # Custom sidebar templates, maps document names to template names.
216 | # html_sidebars = {}
217 | 
218 | # Additional templates that should be rendered to pages, maps page names to
219 | # template names.
220 | # html_additional_pages = {}
221 | 
222 | # If false, no module index is generated.
223 | # html_domain_indices = True
224 | 
225 | # If false, no index is generated.
226 | # html_use_index = True
227 | 
228 | # If true, the index is split into individual pages for each letter.
229 | # html_split_index = False
230 | 
231 | # If true, links to the reST sources are added to the pages.
232 | # html_show_sourcelink = True
233 | 
234 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
235 | # html_show_sphinx = True
236 | 
237 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
238 | # html_show_copyright = True
239 | 
240 | # If true, an OpenSearch description file will be output, and all pages will
241 | # contain a <link> tag referring to it.  The value of this option must be the
242 | # base URL from which the finished HTML is served.
243 | # html_use_opensearch = ''
244 | 
245 | # This is the file name suffix for HTML files (e.g. ".xhtml").
246 | # html_file_suffix = None
247 | 
248 | # Language to be used for generating the HTML full-text search index.
249 | # Sphinx supports the following languages:
250 | #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
251 | #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
252 | # html_search_language = 'en'
253 | 
254 | # A dictionary with options for the search language support, empty by default.
255 | # Now only 'ja' uses this config value
256 | # html_search_options = {'type': 'default'}
257 | 
258 | # The name of a javascript file (relative to the configuration directory) that
259 | # implements a search results scorer. If empty, the default will be used.
260 | html_search_scorer = '_static/scorer.js'
261 | 
262 | html_js_files = ['custom.js', 'settings.js', 'copy.js', 'sidebar.js']
263 | 
264 | # Output file base name for HTML help builder.
265 | htmlhelp_basename = 'Github-API-Wrapper.doc'
266 | 
267 | # -- Options for LaTeX output ---------------------------------------------
268 | 
269 | latex_elements = {
270 |     # The paper size ('letterpaper' or 'a4paper').
271 |     #'papersize': 'letterpaper',
272 |     # The font size ('10pt', '11pt' or '12pt').
273 |     #'pointsize': '10pt',
274 |     # Additional stuff for the LaTeX preamble.
275 |     #'preamble': '',
276 |     # Latex figure (float) alignment
277 |     #'figure_align': 'htbp',
278 | }
279 | 
280 | # Grouping the document tree into LaTeX files. List of tuples
281 | # (source start file, target name, title,
282 | #  author, documentclass [howto, manual, or own class]).
283 | latex_documents = [
284 |     ('index', 'Github-API-Wrapper.tex', 'Github-API-Wrapper Documentation', 'VarMonke & sudosnok', 'manual'),
285 | ]
286 | 
287 | # The name of an image file (relative to this directory) to place at the top of
288 | # the title page.
289 | # latex_logo = None
290 | 
291 | # For "manual" documents, if this is true, then toplevel headings are parts,
292 | # not chapters.
293 | # latex_use_parts = False
294 | 
295 | # If true, show page references after internal links.
296 | # latex_show_pagerefs = False
297 | 
298 | # If true, show URL addresses after external links.
299 | # latex_show_urls = False
300 | 
301 | # Documents to append as an appendix to all manuals.
302 | # latex_appendices = []
303 | 
304 | # If false, no module index is generated.
305 | # latex_domain_indices = True
306 | 
307 | 
308 | # -- Options for manual page output ---------------------------------------
309 | 
310 | # One entry per manual page. List of tuples
311 | # (source start file, name, description, authors, manual section).
312 | man_pages = [('index', 'Github-API-Wrapper', 'Github-API-Wrapper Documentation', ['VarMonke & sudosnok'], 1)]
313 | 
314 | # If true, show URL addresses after external links.
315 | # man_show_urls = False
316 | 
317 | 
318 | # -- Options for Texinfo output -------------------------------------------
319 | 
320 | # Grouping the document tree into Texinfo files. List of tuples
321 | # (source start file, target name, title, author,
322 | #  dir menu entry, description, category)
323 | texinfo_documents = [
324 |     (
325 |         'index',
326 |         'Github-API-Wrapper',
327 |         'Github-API-Wrapper Documentation',
328 |         'VarMonke & sudosnok',
329 |         'Github-API-Wrapper',
330 |         'One line description of project.',
331 |         'Miscellaneous',
332 |     ),
333 | ]
334 | 
335 | # Documents to append as an appendix to all manuals.
336 | # texinfo_appendices = []
337 | 
338 | # If false, no module index is generated.
339 | # texinfo_domain_indices = True
340 | 
341 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
342 | # texinfo_show_urls = 'footnote'
343 | 
344 | # If true, do not generate a @detailmenu in the "Top" node's menu.
345 | # texinfo_no_detailmenu = False
346 | 
347 | 
348 | def setup(app):
349 |     if app.config.language == 'ja':
350 |         app.config.intersphinx_mapping['py'] = ('https://docs.python.org/ja/3', None)
351 |         app.config.html_context['discord_invite'] = 'W2SDTtMrZA'
352 |         app.config.resource_links['discord'] = 'W2SDTtMrZA'
353 | 


--------------------------------------------------------------------------------
/docs/extensions/attributetable.py:
--------------------------------------------------------------------------------
  1 | from __future__ import annotations
  2 | 
  3 | import importlib
  4 | import inspect
  5 | import re
  6 | from typing import TYPE_CHECKING, Dict, List, NamedTuple, Optional, Sequence, Tuple
  7 | 
  8 | from docutils import nodes
  9 | from sphinx import addnodes
 10 | from sphinx.application import Sphinx
 11 | from sphinx.environment import BuildEnvironment
 12 | from sphinx.locale import _
 13 | from sphinx.util.docutils import SphinxDirective
 14 | from sphinx.util.typing import OptionSpec
 15 | 
 16 | if TYPE_CHECKING:
 17 |     from .builder import DPYHTML5Translator
 18 | 
 19 | 
 20 | class attributetable(nodes.General, nodes.Element):
 21 |     pass
 22 | 
 23 | 
 24 | class attributetablecolumn(nodes.General, nodes.Element):
 25 |     pass
 26 | 
 27 | 
 28 | class attributetabletitle(nodes.TextElement):
 29 |     pass
 30 | 
 31 | 
 32 | class attributetableplaceholder(nodes.General, nodes.Element):
 33 |     pass
 34 | 
 35 | 
 36 | class attributetablebadge(nodes.TextElement):
 37 |     pass
 38 | 
 39 | 
 40 | class attributetable_item(nodes.Part, nodes.Element):
 41 |     pass
 42 | 
 43 | 
 44 | def visit_attributetable_node(self: DPYHTML5Translator, node: attributetable) -> None:
 45 |     class_ = node['python-class']
 46 |     self.body.append(f'<div class="py-attribute-table" data-move-to-id="{class_}">')
 47 | 
 48 | 
 49 | def visit_attributetablecolumn_node(self: DPYHTML5Translator, node: attributetablecolumn) -> None:
 50 |     self.body.append(self.starttag(node, 'div', CLASS='py-attribute-table-column'))
 51 | 
 52 | 
 53 | def visit_attributetabletitle_node(self: DPYHTML5Translator, node: attributetabletitle) -> None:
 54 |     self.body.append(self.starttag(node, 'span'))
 55 | 
 56 | 
 57 | def visit_attributetablebadge_node(self: DPYHTML5Translator, node: attributetablebadge) -> None:
 58 |     attributes = {
 59 |         'class': 'py-attribute-table-badge',
 60 |         'title': node['badge-type'],
 61 |     }
 62 |     self.body.append(self.starttag(node, 'span', **attributes))
 63 | 
 64 | 
 65 | def visit_attributetable_item_node(self: DPYHTML5Translator, node: attributetable_item) -> None:
 66 |     self.body.append(self.starttag(node, 'li', CLASS='py-attribute-table-entry'))
 67 | 
 68 | 
 69 | def depart_attributetable_node(self: DPYHTML5Translator, node: attributetable) -> None:
 70 |     self.body.append('</div>')
 71 | 
 72 | 
 73 | def depart_attributetablecolumn_node(self: DPYHTML5Translator, node: attributetablecolumn) -> None:
 74 |     self.body.append('</div>')
 75 | 
 76 | 
 77 | def depart_attributetabletitle_node(self: DPYHTML5Translator, node: attributetabletitle) -> None:
 78 |     self.body.append('</span>')
 79 | 
 80 | 
 81 | def depart_attributetablebadge_node(self: DPYHTML5Translator, node: attributetablebadge) -> None:
 82 |     self.body.append('</span>')
 83 | 
 84 | 
 85 | def depart_attributetable_item_node(self: DPYHTML5Translator, node: attributetable_item) -> None:
 86 |     self.body.append('</li>')
 87 | 
 88 | 
 89 | _name_parser_regex = re.compile(r'(?P<module>[\w.]+\.)?(?P<name>\w+)')
 90 | 
 91 | 
 92 | class PyAttributeTable(SphinxDirective):
 93 |     has_content = False
 94 |     required_arguments = 1
 95 |     optional_arguments = 0
 96 |     final_argument_whitespace = False
 97 |     option_spec: OptionSpec = {}
 98 | 
 99 |     def parse_name(self, content: str) -> Tuple[str, str]:
100 |         match = _name_parser_regex.match(content)
101 |         if match is None:
102 |             raise RuntimeError(f"content {content} somehow doesn't match regex in {self.env.docname}.")
103 |         path, name = match.groups()
104 |         if path:
105 |             modulename = path.rstrip('.')
106 |         else:
107 |             modulename = self.env.temp_data.get('autodoc:module')
108 |             if not modulename:
109 |                 modulename = self.env.ref_context.get('py:module')
110 |         if modulename is None:
111 |             raise RuntimeError(f'modulename somehow None for {content} in {self.env.docname}.')
112 | 
113 |         return modulename, name
114 | 
115 |     def run(self) -> List[attributetableplaceholder]:
116 |         """If you're curious on the HTML this is meant to generate:
117 | 
118 |         <div class="py-attribute-table">
119 |             <div class="py-attribute-table-column">
120 |                 <span>_('Attributes')</span>
121 |                 <ul>
122 |                     <li>
123 |                         <a href="...">
124 |                     </li>
125 |                 </ul>
126 |             </div>
127 |             <div class="py-attribute-table-column">
128 |                 <span>_('Methods')</span>
129 |                 <ul>
130 |                     <li>
131 |                         <a href="..."></a>
132 |                         <span class="py-attribute-badge" title="decorator">D</span>
133 |                     </li>
134 |                 </ul>
135 |             </div>
136 |         </div>
137 | 
138 |         However, since this requires the tree to be complete
139 |         and parsed, it'll need to be done at a different stage and then
140 |         replaced.
141 |         """
142 |         content = self.arguments[0].strip()
143 |         node = attributetableplaceholder('')
144 |         modulename, name = self.parse_name(content)
145 |         node['python-doc'] = self.env.docname
146 |         node['python-module'] = modulename
147 |         node['python-class'] = name
148 |         node['python-full-name'] = f'{modulename}.{name}'
149 |         return [node]
150 | 
151 | 
152 | def build_lookup_table(env: Optional[BuildEnvironment]) -> Dict[str, List[str]]:
153 |     # Given an environment, load up a lookup table of
154 |     # full-class-name: objects
155 |     result = {}
156 |     domain = env.domains['py']  # type: ignore
157 | 
158 |     ignored = {
159 |         'data',
160 |         'exception',
161 |         'module',
162 |         'class',
163 |     }
164 | 
165 |     for fullname, _, objtype, docname, _, _ in domain.get_objects():
166 |         if objtype in ignored:
167 |             continue
168 | 
169 |         classname, _, child = fullname.rpartition('.')
170 |         try:
171 |             result[classname].append(child)
172 |         except KeyError:
173 |             result[classname] = [child]
174 | 
175 |     return result
176 | 
177 | 
178 | class TableElement(NamedTuple):
179 |     fullname: str
180 |     label: str
181 |     badge: Optional[attributetablebadge]
182 | 
183 | 
184 | def process_attributetable(app: Sphinx, doctree: nodes.Node, fromdocname: str) -> None:
185 |     env = app.builder.env  # type: ignore
186 | 
187 |     lookup = build_lookup_table(env)
188 |     for node in doctree.traverse(attributetableplaceholder):
189 |         modulename, classname, fullname = node['python-module'], node['python-class'], node['python-full-name']
190 |         groups = get_class_results(lookup, modulename, classname, fullname)
191 |         table = attributetable('')
192 |         for label, subitems in groups.items():
193 |             if not subitems:
194 |                 continue
195 |             table.append(class_results_to_node(label, sorted(subitems, key=lambda c: c.label)))
196 | 
197 |         table['python-class'] = fullname
198 | 
199 |         if not table:
200 |             node.replace_self([])
201 |         else:
202 |             node.replace_self([table])
203 | 
204 | 
205 | def get_class_results(
206 |     lookup: Dict[str, List[str]], modulename: str, name: str, fullname: str
207 | ) -> Dict[str, List[TableElement]]:
208 |     module = importlib.import_module(modulename)
209 |     cls = getattr(module, name)
210 | 
211 |     groups: Dict[str, List[TableElement]] = {
212 |         _('Attributes'): [],
213 |         _('Methods'): [],
214 |     }
215 | 
216 |     try:
217 |         members = lookup[fullname]
218 |     except KeyError:
219 |         return groups
220 | 
221 |     for attr in members:
222 |         attrlookup = f'{fullname}.{attr}'
223 |         key = _('Attributes')
224 |         badge = None
225 |         label = attr
226 |         value = None
227 | 
228 |         for base in cls.__mro__:
229 |             value = base.__dict__.get(attr)
230 |             if value is not None:
231 |                 break
232 | 
233 |         if value is not None:
234 |             doc = value.__doc__ or ''
235 |             if inspect.iscoroutinefunction(value) or doc.startswith('|coro|'):
236 |                 key = _('Methods')
237 |                 badge = attributetablebadge('async', 'async')
238 |                 badge['badge-type'] = _('coroutine')
239 |             elif isinstance(value, classmethod):
240 |                 key = _('Methods')
241 |                 label = f'{name}.{attr}'
242 |                 badge = attributetablebadge('cls', 'cls')
243 |                 badge['badge-type'] = _('classmethod')
244 |             elif inspect.isfunction(value):
245 |                 if doc.startswith(('A decorator', 'A shortcut decorator')):
246 |                     # finicky but surprisingly consistent
247 |                     key = _('Methods')
248 |                     badge = attributetablebadge('@', '@')
249 |                     badge['badge-type'] = _('decorator')
250 |                 elif inspect.isasyncgenfunction(value):
251 |                     key = _('Methods')
252 |                     badge = attributetablebadge('async for', 'async for')
253 |                     badge['badge-type'] = _('async iterable')
254 |                 else:
255 |                     key = _('Methods')
256 |                     badge = attributetablebadge('def', 'def')
257 |                     badge['badge-type'] = _('method')
258 | 
259 |         groups[key].append(TableElement(fullname=attrlookup, label=label, badge=badge))
260 | 
261 |     return groups
262 | 
263 | 
264 | def class_results_to_node(key: str, elements: Sequence[TableElement]) -> attributetablecolumn:
265 |     title = attributetabletitle(key, key)
266 |     ul = nodes.bullet_list('')
267 |     for element in elements:
268 |         ref = nodes.reference(
269 |             '', '', internal=True, refuri=f'#{element.fullname}', anchorname='', *[nodes.Text(element.label)]
270 |         )
271 |         para = addnodes.compact_paragraph('', '', ref)
272 |         if element.badge is not None:
273 |             ul.append(attributetable_item('', element.badge, para))
274 |         else:
275 |             ul.append(attributetable_item('', para))
276 | 
277 |     return attributetablecolumn('', title, ul)
278 | 
279 | 
280 | def setup(app: Sphinx) -> None:
281 |     app.add_directive('attributetable', PyAttributeTable)
282 |     app.add_node(attributetable, html=(visit_attributetable_node, depart_attributetable_node))
283 |     app.add_node(attributetablecolumn, html=(visit_attributetablecolumn_node, depart_attributetablecolumn_node))
284 |     app.add_node(attributetabletitle, html=(visit_attributetabletitle_node, depart_attributetabletitle_node))
285 |     app.add_node(attributetablebadge, html=(visit_attributetablebadge_node, depart_attributetablebadge_node))
286 |     app.add_node(attributetable_item, html=(visit_attributetable_item_node, depart_attributetable_item_node))
287 |     app.add_node(attributetableplaceholder)
288 |     app.connect('doctree-resolved', process_attributetable)
289 | 


--------------------------------------------------------------------------------
/docs/extensions/builder.py:
--------------------------------------------------------------------------------
 1 | from sphinx.builders.html import StandaloneHTMLBuilder
 2 | from sphinx.environment.adapters.indexentries import IndexEntries
 3 | from sphinx.writers.html5 import HTML5Translator
 4 | 
 5 | 
 6 | class DPYHTML5Translator(HTML5Translator):
 7 |     def visit_section(self, node):
 8 |         self.section_level += 1
 9 |         self.body.append(self.starttag(node, 'section'))
10 | 
11 |     def depart_section(self, node):
12 |         self.section_level -= 1
13 |         self.body.append('</section>\n')
14 | 
15 |     def visit_table(self, node):
16 |         self.body.append('<div class="table-wrapper">')
17 |         super().visit_table(node)
18 | 
19 |     def depart_table(self, node):
20 |         super().depart_table(node)
21 |         self.body.append('</div>')
22 | 
23 | 
24 | class DPYStandaloneHTMLBuilder(StandaloneHTMLBuilder):
25 |     # This is mostly copy pasted from Sphinx.
26 |     def write_genindex(self) -> None:
27 |         # the total count of lines for each index letter, used to distribute
28 |         # the entries into two columns
29 |         genindex = IndexEntries(self.env).create_index(self, group_entries=False)  # type: ignore
30 |         indexcounts = []
31 |         for _k, entries in genindex:
32 |             indexcounts.append(sum(1 + len(subitems) for _, (_, subitems, _) in entries))
33 | 
34 |         genindexcontext = {
35 |             'genindexentries': genindex,
36 |             'genindexcounts': indexcounts,
37 |             'split_index': self.config.html_split_index,
38 |         }
39 | 
40 |         if self.config.html_split_index:
41 |             self.handle_page('genindex', genindexcontext, 'genindex-split.html')
42 |             self.handle_page('genindex-all', genindexcontext, 'genindex.html')
43 |             for (key, entries), count in zip(genindex, indexcounts):
44 |                 ctx = {'key': key, 'entries': entries, 'count': count, 'genindexentries': genindex}
45 |                 self.handle_page(f"genindex-{key}", ctx, 'genindex-single.html')
46 |         else:
47 |             self.handle_page('genindex', genindexcontext, 'genindex.html')
48 | 
49 | 
50 | def add_custom_jinja2(app):
51 |     env = app.builder.templates.environment
52 |     env.tests['prefixedwith'] = str.startswith
53 |     env.tests['suffixedwith'] = str.endswith
54 | 
55 | 
56 | def add_builders(app):
57 |     """This is necessary because RTD injects their own for some reason."""
58 |     app.set_translator('html', DPYHTML5Translator, override=True)
59 |     app.add_builder(DPYStandaloneHTMLBuilder, override=True)
60 | 
61 |     try:
62 |         original = app.registry.builders['readthedocs']
63 |     except KeyError:
64 |         pass
65 |     else:
66 |         injected_mro = tuple(
67 |             base if base is not StandaloneHTMLBuilder else DPYStandaloneHTMLBuilder for base in original.mro()[1:]
68 |         )
69 |         new_builder = type(original.__name__, injected_mro, {'name': 'readthedocs'})
70 |         app.set_translator('readthedocs', DPYHTML5Translator, override=True)
71 |         app.add_builder(new_builder, override=True)
72 | 
73 | 
74 | def setup(app):
75 |     add_builders(app)
76 |     app.connect('builder-inited', add_custom_jinja2)
77 | 


--------------------------------------------------------------------------------
/docs/extensions/details.py:
--------------------------------------------------------------------------------
 1 | from docutils import nodes
 2 | from docutils.parsers.rst import directives  # type: ignore
 3 | from docutils.parsers.rst import Directive
 4 | from docutils.parsers.rst.roles import set_classes
 5 | 
 6 | 
 7 | class details(nodes.General, nodes.Element):
 8 |     pass
 9 | 
10 | 
11 | class summary(nodes.General, nodes.Element):
12 |     pass
13 | 
14 | 
15 | def visit_details_node(self, node):
16 |     self.body.append(self.starttag(node, 'details', CLASS=node.attributes.get('class', '')))
17 | 
18 | 
19 | def visit_summary_node(self, node):
20 |     self.body.append(self.starttag(node, 'summary', CLASS=node.attributes.get('summary-class', '')))
21 |     self.body.append(node.rawsource)
22 | 
23 | 
24 | def depart_details_node(self, node):
25 |     self.body.append('</details>\n')
26 | 
27 | 
28 | def depart_summary_node(self, node):
29 |     self.body.append('</summary>')
30 | 
31 | 
32 | class DetailsDirective(Directive):
33 |     final_argument_whitespace = True
34 |     optional_arguments = 1
35 | 
36 |     option_spec = {
37 |         'class': directives.class_option,
38 |         'summary-class': directives.class_option,
39 |     }
40 | 
41 |     has_content = True
42 | 
43 |     def run(self):
44 |         set_classes(self.options)
45 |         self.assert_has_content()
46 | 
47 |         text = '\n'.join(self.content)
48 |         node = details(text, **self.options)
49 | 
50 |         if self.arguments:
51 |             summary_node = summary(self.arguments[0], **self.options)
52 |             summary_node.source, summary_node.line = self.state_machine.get_source_and_line(self.lineno)
53 |             node += summary_node
54 | 
55 |         self.state.nested_parse(self.content, self.content_offset, node)
56 |         return [node]
57 | 
58 | 
59 | def setup(app):
60 |     app.add_node(details, html=(visit_details_node, depart_details_node))
61 |     app.add_node(summary, html=(visit_summary_node, depart_summary_node))
62 |     app.add_directive('details', DetailsDirective)
63 | 


--------------------------------------------------------------------------------
/docs/extensions/exception_hierarchy.py:
--------------------------------------------------------------------------------
 1 | from docutils import nodes
 2 | from docutils.parsers.rst import Directive
 3 | 
 4 | 
 5 | class exception_hierarchy(nodes.General, nodes.Element):
 6 |     pass
 7 | 
 8 | 
 9 | def visit_exception_hierarchy_node(self, node):
10 |     self.body.append(self.starttag(node, 'div', CLASS='exception-hierarchy-content'))
11 | 
12 | 
13 | def depart_exception_hierarchy_node(self, node):
14 |     self.body.append('</div>\n')
15 | 
16 | 
17 | class ExceptionHierarchyDirective(Directive):
18 |     has_content = True
19 | 
20 |     def run(self):
21 |         self.assert_has_content()
22 |         node = exception_hierarchy('\n'.join(self.content))
23 |         self.state.nested_parse(self.content, self.content_offset, node)
24 |         return [node]
25 | 
26 | 
27 | def setup(app):
28 |     app.add_node(exception_hierarchy, html=(visit_exception_hierarchy_node, depart_exception_hierarchy_node))
29 |     app.add_directive('exception_hierarchy', ExceptionHierarchyDirective)
30 | 


--------------------------------------------------------------------------------
/docs/extensions/nitpick_file_ignorer.py:
--------------------------------------------------------------------------------
 1 | import logging
 2 | 
 3 | from sphinx.application import Sphinx
 4 | from sphinx.util import logging as sphinx_logging
 5 | 
 6 | 
 7 | class NitpickFileIgnorer(logging.Filter):
 8 |     def __init__(self, app: Sphinx) -> None:
 9 |         self.app = app
10 |         super().__init__()
11 | 
12 |     def filter(self, record: sphinx_logging.SphinxLogRecord) -> bool:
13 |         if getattr(record, 'type', None) == 'ref':
14 |             return record.location.get('refdoc') not in self.app.config.nitpick_ignore_files
15 |         return True
16 | 
17 | 
18 | def setup(app: Sphinx):
19 |     app.add_config_value('nitpick_ignore_files', [], '')
20 |     f = NitpickFileIgnorer(app)
21 |     sphinx_logging.getLogger('sphinx.transforms.post_transforms').logger.addFilter(f)
22 | 


--------------------------------------------------------------------------------
/docs/extensions/resourcelinks.py:
--------------------------------------------------------------------------------
 1 | # Credit to sphinx.ext.extlinks for being a good starter
 2 | # Copyright 2007-2020 by the Sphinx team
 3 | # Licensed under BSD.
 4 | 
 5 | from typing import Any, Dict, List, Tuple
 6 | 
 7 | import sphinx
 8 | from docutils import nodes, utils
 9 | from docutils.nodes import Node, system_message
10 | from docutils.parsers.rst.states import Inliner
11 | from sphinx.application import Sphinx
12 | from sphinx.util.nodes import split_explicit_title
13 | from sphinx.util.typing import RoleFunction
14 | 
15 | 
16 | def make_link_role(resource_links: Dict[str, str]) -> RoleFunction:
17 |     def role(
18 |         typ: str, rawtext: str, text: str, lineno: int, inliner: Inliner, options: Dict = {}, content: List[str] = []
19 |     ) -> Tuple[List[Node], List[system_message]]:
20 |         text = utils.unescape(text)
21 |         has_explicit_title, title, key = split_explicit_title(text)
22 |         full_url = resource_links[key]
23 |         if not has_explicit_title:
24 |             title = full_url
25 |         pnode = nodes.reference(title, title, internal=False, refuri=full_url)
26 |         return [pnode], []
27 | 
28 |     return role
29 | 
30 | 
31 | def add_link_role(app: Sphinx) -> None:
32 |     app.add_role('resource', make_link_role(app.config.resource_links))
33 | 
34 | 
35 | def setup(app: Sphinx) -> Dict[str, Any]:
36 |     app.add_config_value('resource_links', {}, 'env')
37 |     app.connect('builder-inited', add_link_role)
38 |     return {'version': sphinx.__display_version__, 'parallel_read_safe': True}
39 | 


--------------------------------------------------------------------------------
/docs/images/Github-Python-rounded.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/VarMonke/GitHub-API-Wrapper/dd5d5d4923ef2083f589b15202e87b918a23c3e9/docs/images/Github-Python-rounded.png


--------------------------------------------------------------------------------
/docs/images/Github-Python.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/VarMonke/GitHub-API-Wrapper/dd5d5d4923ef2083f589b15202e87b918a23c3e9/docs/images/Github-Python.png


--------------------------------------------------------------------------------
/docs/images/discord_py_logo.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/VarMonke/GitHub-API-Wrapper/dd5d5d4923ef2083f589b15202e87b918a23c3e9/docs/images/discord_py_logo.ico


--------------------------------------------------------------------------------
/docs/images/drop_down_icon.svg:
--------------------------------------------------------------------------------
1 | <svg fill='white' height='24' viewBox='0 0 24 24' width='24' xmlns='http://www.w3.org/2000/svg'>
2 |     <path d='M7 10l5 5 5-5z'/>
3 |     <path d='M0 0h24v24H0z' fill='none'/>
4 | </svg>
5 | 


--------------------------------------------------------------------------------
/docs/images/icon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/VarMonke/GitHub-API-Wrapper/dd5d5d4923ef2083f589b15202e87b918a23c3e9/docs/images/icon.ico


--------------------------------------------------------------------------------
/docs/images/snake.svg:
--------------------------------------------------------------------------------
 1 | <svg style="width: 100%; height: 100%" 
 2 |     xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1036 597.33331" height="597.333" width="1036">
 3 |     <path d="M498.46 84.248c-1.6 1.665-2.4 3.597-2.4 5.93 0 2.333.8 4.265 2.4 5.863 1.667 1.67 3.6 2.47 5.932 2.47 2.332 0 4.265-.8 5.864-2.46 1.665-1.59 2.465-3.53 2.465-5.86 0-2.33-.8-4.26-2.46-5.93-1.6-1.6-3.53-2.4-5.86-2.4s-4.26.8-5.93 2.4m-9.06 5.93c0-2.33-.8-4.26-2.46-5.93-1.6-1.6-3.53-2.4-5.862-2.4s-4.265.8-5.93 2.4c-1.6 1.67-2.4 3.6-2.4 5.93 0 2.33.8 4.27 2.4 5.86 1.665 1.67 3.598 2.47 5.93 2.47s4.265-.8 5.864-2.46c1.663-1.593 2.463-3.53 2.463-5.86m46.647 0c0-2.333-.8-4.27-2.467-5.93-1.6-1.6-3.53-2.4-5.86-2.4s-4.265.8-5.93 2.4c-1.6 1.665-2.4 3.597-2.4 5.93 0 2.333.8 4.265 2.4 5.863 1.665 1.67 3.598 2.467 5.93 2.467s4.265-.8 5.864-2.468c1.667-1.598 2.467-3.53 2.467-5.86" fill="#e0e0e0"/>
 4 |     <path d="M2748.2-850.22H155.382c-76.964 0-115.447-48.474-115.447-144.932V-4303.65c0-96.45 38.483-144.93 115.447-144.93H6321.57c76.97 0 115.45 48.48 115.45 144.93v3308.498c0 96.458-38.48 144.933-115.45 144.933H3737.75" fill="none" stroke="#e0e0e0" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 5 |     <path d="M4177.05-3798.87v2178.5H998.996v-2178.5c0-133.44 66.474-199.91 199.914-199.91h2778.23c133.44 0 199.91 66.47 199.91 199.91z" fill="none" stroke="#e0e0e0" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 6 |     <path d="M6274.1-4181.2v2844.7c0 82.97-36.49 124.45-108.95 124.45H322.307c-72.47 0-108.952-41.48-108.952-124.45v-2844.7c0-82.96 36.483-124.44 108.952-124.44H6165.15c72.46 0 108.95 41.48 108.95 124.44zM449.25-41.084h147.43m182.418 0h339.842m1407.86 0c0-91.458 46.98-151.43 140.94-179.92 23.99-7.497 50.97-12.493 80.46-15.993m0 0c24.49-2.497 51.48-3.997 79.96-3.997h820.63c32.49 0 61.97 2 88.96 5.497M1348.84-41.084H2526.8m221.4-195.913V-850.22m989.55 614.723c26.49 3 49.98 7.996 71.47 14.493 93.96 28.49 140.93 88.462 140.93 179.92m2024.08 0h50.98m-468.28 0h219.89m-1826.67 0h1416.86M3737.75-235.497V-850.22m212.4 809.136H2526.8M3737.75-850.22H2748.2" fill="none" stroke="#e0e0e0" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 7 |     <path d="M2126.79-2789.58c-38.13 38.49-57.37 85.01-57.37 139.59 0 54.22 19.24 100.75 57.37 139.23 38.48 38.48 85.01 57.73 139.59 57.73 54.22 0 100.75-19.25 139.23-57.73 38.49-38.48 57.73-85.01 57.73-139.23 0-54.58-19.24-101.1-57.73-139.59-38.48-38.13-85.01-57.37-139.23-57.37-54.58 0-101.11 19.24-139.59 57.37z" fill="none" stroke="#e0e0e0" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 8 |     <path d="M2640.7-3448.32c-286.51-11.2-546.09 38.83-778.73 150.43 143.08-106.7 307.5-172.47 493.27-197.66-6.3-14.34-18.9-29.04-38.13-43.73h-62.98c-210.25 36.73-380.62 103.9-511.11 201.16-197.66 325.7-291.76 678.68-281.62 1058.6 142.39 189.97 349.49 279.53 621.31 267.98l122.45-129.44c-148.68-52.82-255.03-123.49-318.7-212 214.1 133.99 465.63 199.41 754.24 196.26" fill="none" stroke="#e0e0e0" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 9 |     <path d="M-3149.74-2789.58c-38.13 38.49-57.37 85.01-57.37 139.59 0 54.22 19.24 100.75 57.37 139.23 38.49 38.48 85.01 57.73 139.59 57.73 54.22 0 100.75-19.25 139.23-57.73 38.49-38.48 57.73-85.01 57.73-139.23 0-54.58-19.24-101.1-57.73-139.59-38.48-38.13-85.01-57.37-139.23-57.37-54.58 0-101.1 19.24-139.59 57.37z" fill="none" stroke="#e0e0e0" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(-.13334 0 0 .13333 0 597.333)"/>
10 |     <path d="M-2635.83-3448.32c-286.51-11.2-546.09 38.83-778.73 150.43 143.08-106.7 307.5-172.47 493.27-197.66-6.3-14.34-18.89-29.04-38.13-43.73h-62.98c-210.25 36.73-380.62 103.9-511.11 201.16-197.66 325.7-291.76 678.68-281.62 1058.6 142.39 189.97 349.49 279.53 621.32 267.98l122.44-129.44c-148.68-52.82-255.03-123.49-318.7-212 214.1 133.99 465.63 199.41 754.24 196.26" fill="none" stroke="#e0e0e0" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(-.13334 0 0 .13333 0 597.333)"/>
11 |     <path d="M474.47 230.785c-17.793 0-26.655 8.863-26.655 26.654v261.2-23.99H207.912h47.98v-58.9 34.91h143.94-47.98v23.99h95.963v-94.88c-.534-16.73-9.396-25.06-26.656-25.06H186.58c-17.792 0-26.656 8.86-26.656 26.65v163.85c0 17.26 8.33 26.12 25.057 26.65h333.8c16.66-.53 24.99-9.39 24.99-26.65V326.74h-34.65c-16.66.667-24.65-7.33-23.99-23.987h300.28c4.2-7.13 6.27-15.126 6.27-23.99v-21.32c0-17.792-8.86-26.655-26.65-26.655zm-13.327 311.842l23.99 22.588-23.99-22.588" fill="#eadc62"/>
12 |     <path d="M777.616 312.677c3.132-3.132 5.73-6.397 7.796-9.928h-300.28c-.665 16.65 7.33 24.65 23.992 23.98h234.572c13.26 0 24.523-4.67 33.92-14.06" fill="#f2edc8"/>
13 |     <path d="M3890.68-40.99H1387.32m1971.1-1440.85v-1067.51c0-133.44 66.47-199.91 199.91-199.91h2179.01c133.44 0 199.91 66.47 199.91 199.91v159.93c0 66.47-15.49 126.44-46.98 179.92" fill="none" stroke="#000" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
14 |     <path d="M5890.27-2209.5c-15.49 26.48-34.98 50.97-58.47 74.46-70.47 70.47-154.93 105.45-254.39 105.45H4078.1M3358.42-590.243V-770.16m719.68-1259.43h-259.88m-459.8 1259.43v-711.68M3638.3-240.9l-179.92-169.423M4449.93-40.99h-559.25m187.42-1988.6V-240.9c0 129.44-62.48 195.91-187.42 199.91m1007.04 0H4717.8M1559.24-770.16h359.84m4777.83-1259.43l-179.92-179.91m0 0l179.92-179.92M949.022-40.99h438.298M6516.99-2209.5h-626.72m-3971.19 997.54v261.88m0 0v179.92m1079.51-179.92h-359.84m0 0v179.92m-719.67-179.92h719.67m0 179.92h-719.67M1387.32-40.99c-125.44-4-187.91-70.47-187.91-199.91v-1228.94c0-133.44 66.47-199.91 199.9-199.91h1759.2c129.45 0 195.92 62.47 199.91 187.91m-719.67 711.68h719.67" fill="none" stroke="#000" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
15 |     <path d="M7716.44-2209.5H7356.6m0 539.75l-179.92-179.92m179.92-899.59l-179.92 179.92" fill="none" stroke="#e0e0e0" stroke-width="99.954" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
16 |     <path d="M769.485 258.24c-2.332-2.333-5.13-3.467-8.462-3.467s-6.198 1.134-8.53 3.466c-2.333 2.33-3.466 5.19-3.466 8.52s1.133 6.13 3.466 8.46c2.332 2.33 5.198 3.53 8.53 3.53 3.332 0 6.13-1.2 8.462-3.53 2.334-2.34 3.532-5.13 3.532-8.47 0-3.33-1.198-6.2-3.532-8.53"/>
17 | </svg>
18 | 


--------------------------------------------------------------------------------
/docs/images/snake_dark.svg:
--------------------------------------------------------------------------------
 1 | <svg style="width: 100%; height: 100%"
 2 | 	xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1036 597.33331" height="597.333" width="1036">
 3 | 	<path d="M498.46 84.248c-1.6 1.665-2.4 3.597-2.4 5.93 0 2.333.8 4.265 2.4 5.863 1.667 1.67 3.6 2.47 5.932 2.47 2.332 0 4.265-.8 5.864-2.46 1.665-1.59 2.465-3.53 2.465-5.86 0-2.33-.8-4.26-2.46-5.93-1.6-1.6-3.53-2.4-5.86-2.4s-4.26.8-5.93 2.4m-9.06 5.93c0-2.33-.8-4.26-2.46-5.93-1.6-1.6-3.53-2.4-5.862-2.4s-4.265.8-5.93 2.4c-1.6 1.67-2.4 3.6-2.4 5.93 0 2.33.8 4.27 2.4 5.86 1.665 1.67 3.598 2.47 5.93 2.47s4.265-.8 5.864-2.46c1.663-1.593 2.463-3.53 2.463-5.86m46.647 0c0-2.333-.8-4.27-2.467-5.93-1.6-1.6-3.53-2.4-5.86-2.4s-4.265.8-5.93 2.4c-1.6 1.665-2.4 3.597-2.4 5.93 0 2.333.8 4.265 2.4 5.863 1.665 1.67 3.598 2.467 5.93 2.467s4.265-.8 5.864-2.468c1.667-1.598 2.467-3.53 2.467-5.86" fill="#161616"/>
 4 | 	<path d="M2748.2-850.22H155.382c-76.964 0-115.447-48.474-115.447-144.932V-4303.65c0-96.45 38.483-144.93 115.447-144.93H6321.57c76.97 0 115.45 48.48 115.45 144.93v3308.498c0 96.458-38.48 144.933-115.45 144.933H3737.75" fill="none" stroke="#161616" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 5 | 	<path d="M4177.05-3798.87v2178.5H998.996v-2178.5c0-133.44 66.474-199.91 199.914-199.91h2778.23c133.44 0 199.91 66.47 199.91 199.91z" fill="none" stroke="#161616" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 6 | 	<path d="M6274.1-4181.2v2844.7c0 82.97-36.49 124.45-108.95 124.45H322.307c-72.47 0-108.952-41.48-108.952-124.45v-2844.7c0-82.96 36.483-124.44 108.952-124.44H6165.15c72.46 0 108.95 41.48 108.95 124.44zM449.25-41.084h147.43m182.418 0h339.842m1407.86 0c0-91.458 46.98-151.43 140.94-179.92 23.99-7.497 50.97-12.493 80.46-15.993m0 0c24.49-2.497 51.48-3.997 79.96-3.997h820.63c32.49 0 61.97 2 88.96 5.497M1348.84-41.084H2526.8m221.4-195.913V-850.22m989.55 614.723c26.49 3 49.98 7.996 71.47 14.493 93.96 28.49 140.93 88.462 140.93 179.92m2024.08 0h50.98m-468.28 0h219.89m-1826.67 0h1416.86M3737.75-235.497V-850.22m212.4 809.136H2526.8M3737.75-850.22H2748.2" fill="none" stroke="#161616" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 7 | 	<path d="M2126.79-2789.58c-38.13 38.49-57.37 85.01-57.37 139.59 0 54.22 19.24 100.75 57.37 139.23 38.48 38.48 85.01 57.73 139.59 57.73 54.22 0 100.75-19.25 139.23-57.73 38.49-38.48 57.73-85.01 57.73-139.23 0-54.58-19.24-101.1-57.73-139.59-38.48-38.13-85.01-57.37-139.23-57.37-54.58 0-101.11 19.24-139.59 57.37z" fill="none" stroke="#161616" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 8 | 	<path d="M2640.7-3448.32c-286.51-11.2-546.09 38.83-778.73 150.43 143.08-106.7 307.5-172.47 493.27-197.66-6.3-14.34-18.9-29.04-38.13-43.73h-62.98c-210.25 36.73-380.62 103.9-511.11 201.16-197.66 325.7-291.76 678.68-281.62 1058.6 142.39 189.97 349.49 279.53 621.31 267.98l122.45-129.44c-148.68-52.82-255.03-123.49-318.7-212 214.1 133.99 465.63 199.41 754.24 196.26" fill="none" stroke="#161616" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
 9 | 	<path d="M-3149.74-2789.58c-38.13 38.49-57.37 85.01-57.37 139.59 0 54.22 19.24 100.75 57.37 139.23 38.49 38.48 85.01 57.73 139.59 57.73 54.22 0 100.75-19.25 139.23-57.73 38.49-38.48 57.73-85.01 57.73-139.23 0-54.58-19.24-101.1-57.73-139.59-38.48-38.13-85.01-57.37-139.23-57.37-54.58 0-101.1 19.24-139.59 57.37z" fill="none" stroke="#161616" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(-.13334 0 0 .13333 0 597.333)"/>
10 | 	<path d="M-2635.83-3448.32c-286.51-11.2-546.09 38.83-778.73 150.43 143.08-106.7 307.5-172.47 493.27-197.66-6.3-14.34-18.89-29.04-38.13-43.73h-62.98c-210.25 36.73-380.62 103.9-511.11 201.16-197.66 325.7-291.76 678.68-281.62 1058.6 142.39 189.97 349.49 279.53 621.32 267.98l122.44-129.44c-148.68-52.82-255.03-123.49-318.7-212 214.1 133.99 465.63 199.41 754.24 196.26" fill="none" stroke="#161616" stroke-width="69.967" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(-.13334 0 0 .13333 0 597.333)"/>
11 | 	<path d="M474.47 230.785c-17.793 0-26.655 8.863-26.655 26.654v261.2-23.99H207.912h47.98v-58.9 34.91h143.94-47.98v23.99h95.963v-94.88c-.534-16.73-9.396-25.06-26.656-25.06H186.58c-17.792 0-26.656 8.86-26.656 26.65v163.85c0 17.26 8.33 26.12 25.057 26.65h333.8c16.66-.53 24.99-9.39 24.99-26.65V326.74h-34.65c-16.66.667-24.65-7.33-23.99-23.987h300.28c4.2-7.13 6.27-15.126 6.27-23.99v-21.32c0-17.792-8.86-26.655-26.65-26.655zm-13.327 311.842l23.99 22.588-23.99-22.588" fill="#376fa1"/>
12 | 	<path d="M777.616 312.677c3.132-3.132 5.73-6.397 7.796-9.928h-300.28c-.665 16.65 7.33 24.65 23.992 23.98h234.572c13.26 0 24.523-4.67 33.92-14.06" fill="#578fc1"/>
13 | 	<path d="M3890.68-40.99H1387.32m1971.1-1440.85v-1067.51c0-133.44 66.47-199.91 199.91-199.91h2179.01c133.44 0 199.91 66.47 199.91 199.91v159.93c0 66.47-15.49 126.44-46.98 179.92" fill="none" stroke="#000" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
14 | 	<path d="M5890.27-2209.5c-15.49 26.48-34.98 50.97-58.47 74.46-70.47 70.47-154.93 105.45-254.39 105.45H4078.1M3358.42-590.243V-770.16m719.68-1259.43h-259.88m-459.8 1259.43v-711.68M3638.3-240.9l-179.92-169.423M4449.93-40.99h-559.25m187.42-1988.6V-240.9c0 129.44-62.48 195.91-187.42 199.91m1007.04 0H4717.8M1559.24-770.16h359.84m4777.83-1259.43l-179.92-179.91m0 0l179.92-179.92M949.022-40.99h438.298M6516.99-2209.5h-626.72m-3971.19 997.54v261.88m0 0v179.92m1079.51-179.92h-359.84m0 0v179.92m-719.67-179.92h719.67m0 179.92h-719.67M1387.32-40.99c-125.44-4-187.91-70.47-187.91-199.91v-1228.94c0-133.44 66.47-199.91 199.9-199.91h1759.2c129.45 0 195.92 62.47 199.91 187.91m-719.67 711.68h719.67" fill="none" stroke="#000" stroke-width="79.964" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
15 | 	<path d="M7716.44-2209.5H7356.6m0 539.75l-179.92-179.92m179.92-899.59l-179.92 179.92" fill="none" stroke="#161616" stroke-width="99.954" stroke-linecap="round" stroke-linejoin="round" stroke-miterlimit="10" transform="matrix(.13334 0 0 .13333 0 597.333)"/>
16 | 	<path d="M769.485 258.24c-2.332-2.333-5.13-3.467-8.462-3.467s-6.198 1.134-8.53 3.466c-2.333 2.33-3.466 5.19-3.466 8.52s1.133 6.13 3.466 8.46c2.332 2.33 5.198 3.53 8.53 3.53 3.332 0 6.13-1.2 8.462-3.53 2.334-2.34 3.532-5.13 3.532-8.47 0-3.33-1.198-6.2-3.532-8.53"/>
17 | </svg>
18 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | .. Github-API-Wrapper documentation master file, created by
 2 |    sphinx-quickstart on Sun May  1 15:39:50 2022.
 3 |    You can adapt this file completely to your liking, but it should at least
 4 |    contain the root `toctree` directive.
 5 | 
 6 | Welcome to Github-API-Wrapper.
 7 | ==============================================
 8 | 
 9 | .. automodule:: github
10 | 
11 | 
12 | .. toctree::
13 |    :maxdepth: 2
14 |    :caption: Contents:
15 | 
16 |    api
17 | 
18 | 
19 | 
20 | 
21 | Indices and tables
22 | ==================
23 | 
24 | * :ref:`genindex`
25 | * :ref:`modindex`
26 | * :ref:`search`
27 | 


--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
  1 | @ECHO OFF
  2 | 
  3 | REM Command file for Sphinx documentation
  4 | 
  5 | if "%SPHINXBUILD%" == "" (
  6 | 	set SPHINXBUILD=sphinx-build
  7 | )
  8 | set BUILDDIR=_build
  9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 10 | set I18NSPHINXOPTS=%SPHINXOPTS% .
 11 | if NOT "%PAPER%" == "" (
 12 | 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 13 | 	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
 14 | )
 15 | 
 16 | if "%1" == "" goto help
 17 | 
 18 | if "%1" == "help" (
 19 | 	:help
 20 | 	echo.Please use `make ^<target^>` where ^<target^> is one of
 21 | 	echo.  html       to make standalone HTML files
 22 | 	echo.  dirhtml    to make HTML files named index.html in directories
 23 | 	echo.  singlehtml to make a single large HTML file
 24 | 	echo.  pickle     to make pickle files
 25 | 	echo.  json       to make JSON files
 26 | 	echo.  htmlhelp   to make HTML files and a HTML help project
 27 | 	echo.  qthelp     to make HTML files and a qthelp project
 28 | 	echo.  devhelp    to make HTML files and a Devhelp project
 29 | 	echo.  epub       to make an epub
 30 | 	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
 31 | 	echo.  text       to make text files
 32 | 	echo.  man        to make manual pages
 33 | 	echo.  texinfo    to make Texinfo files
 34 | 	echo.  gettext    to make PO message catalogs
 35 | 	echo.  changes    to make an overview over all changed/added/deprecated items
 36 | 	echo.  xml        to make Docutils-native XML files
 37 | 	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
 38 | 	echo.  linkcheck  to check all external links for integrity
 39 | 	echo.  doctest    to run all doctests embedded in the documentation if enabled
 40 | 	echo.  coverage   to run coverage check of the documentation if enabled
 41 | 	goto end
 42 | )
 43 | 
 44 | if "%1" == "clean" (
 45 | 	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
 46 | 	del /q /s %BUILDDIR%\*
 47 | 	goto end
 48 | )
 49 | 
 50 | 
 51 | REM Check if sphinx-build is available and fallback to Python version if any
 52 | %SPHINXBUILD% 2> nul
 53 | if errorlevel 9009 goto sphinx_python
 54 | goto sphinx_ok
 55 | 
 56 | :sphinx_python
 57 | 
 58 | set SPHINXBUILD=python -m sphinx.__init__
 59 | %SPHINXBUILD% 2> nul
 60 | if errorlevel 9009 (
 61 | 	echo.
 62 | 	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
 63 | 	echo.installed, then set the SPHINXBUILD environment variable to point
 64 | 	echo.to the full path of the 'sphinx-build' executable. Alternatively you
 65 | 	echo.may add the Sphinx directory to PATH.
 66 | 	echo.
 67 | 	echo.If you don't have Sphinx installed, grab it from
 68 | 	echo.http://sphinx-doc.org/
 69 | 	exit /b 1
 70 | )
 71 | 
 72 | :sphinx_ok
 73 | 
 74 | 
 75 | if "%1" == "html" (
 76 | 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 77 | 	if errorlevel 1 exit /b 1
 78 | 	echo.
 79 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
 80 | 	goto end
 81 | )
 82 | 
 83 | if "%1" == "dirhtml" (
 84 | 	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
 85 | 	if errorlevel 1 exit /b 1
 86 | 	echo.
 87 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
 88 | 	goto end
 89 | )
 90 | 
 91 | if "%1" == "singlehtml" (
 92 | 	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
 93 | 	if errorlevel 1 exit /b 1
 94 | 	echo.
 95 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
 96 | 	goto end
 97 | )
 98 | 
 99 | if "%1" == "pickle" (
100 | 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
101 | 	if errorlevel 1 exit /b 1
102 | 	echo.
103 | 	echo.Build finished; now you can process the pickle files.
104 | 	goto end
105 | )
106 | 
107 | if "%1" == "json" (
108 | 	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
109 | 	if errorlevel 1 exit /b 1
110 | 	echo.
111 | 	echo.Build finished; now you can process the JSON files.
112 | 	goto end
113 | )
114 | 
115 | if "%1" == "htmlhelp" (
116 | 	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
117 | 	if errorlevel 1 exit /b 1
118 | 	echo.
119 | 	echo.Build finished; now you can run HTML Help Workshop with the ^
120 | .hhp project file in %BUILDDIR%/htmlhelp.
121 | 	goto end
122 | )
123 | 
124 | if "%1" == "qthelp" (
125 | 	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
126 | 	if errorlevel 1 exit /b 1
127 | 	echo.
128 | 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
129 | .qhcp project file in %BUILDDIR%/qthelp, like this:
130 | 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\discord.py.qhcp
131 | 	echo.To view the help file:
132 | 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\discord.py.ghc
133 | 	goto end
134 | )
135 | 
136 | if "%1" == "devhelp" (
137 | 	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
138 | 	if errorlevel 1 exit /b 1
139 | 	echo.
140 | 	echo.Build finished.
141 | 	goto end
142 | )
143 | 
144 | if "%1" == "epub" (
145 | 	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
146 | 	if errorlevel 1 exit /b 1
147 | 	echo.
148 | 	echo.Build finished. The epub file is in %BUILDDIR%/epub.
149 | 	goto end
150 | )
151 | 
152 | if "%1" == "latex" (
153 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
154 | 	if errorlevel 1 exit /b 1
155 | 	echo.
156 | 	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
157 | 	goto end
158 | )
159 | 
160 | if "%1" == "latexpdf" (
161 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
162 | 	cd %BUILDDIR%/latex
163 | 	make all-pdf
164 | 	cd %~dp0
165 | 	echo.
166 | 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
167 | 	goto end
168 | )
169 | 
170 | if "%1" == "latexpdfja" (
171 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
172 | 	cd %BUILDDIR%/latex
173 | 	make all-pdf-ja
174 | 	cd %~dp0
175 | 	echo.
176 | 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
177 | 	goto end
178 | )
179 | 
180 | if "%1" == "text" (
181 | 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
182 | 	if errorlevel 1 exit /b 1
183 | 	echo.
184 | 	echo.Build finished. The text files are in %BUILDDIR%/text.
185 | 	goto end
186 | )
187 | 
188 | if "%1" == "man" (
189 | 	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
190 | 	if errorlevel 1 exit /b 1
191 | 	echo.
192 | 	echo.Build finished. The manual pages are in %BUILDDIR%/man.
193 | 	goto end
194 | )
195 | 
196 | if "%1" == "texinfo" (
197 | 	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
198 | 	if errorlevel 1 exit /b 1
199 | 	echo.
200 | 	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
201 | 	goto end
202 | )
203 | 
204 | if "%1" == "gettext" (
205 | 	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
206 | 	if errorlevel 1 exit /b 1
207 | 	echo.
208 | 	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
209 | 	goto end
210 | )
211 | 
212 | if "%1" == "changes" (
213 | 	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
214 | 	if errorlevel 1 exit /b 1
215 | 	echo.
216 | 	echo.The overview file is in %BUILDDIR%/changes.
217 | 	goto end
218 | )
219 | 
220 | if "%1" == "linkcheck" (
221 | 	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
222 | 	if errorlevel 1 exit /b 1
223 | 	echo.
224 | 	echo.Link check complete; look for any errors in the above output ^
225 | or in %BUILDDIR%/linkcheck/output.txt.
226 | 	goto end
227 | )
228 | 
229 | if "%1" == "doctest" (
230 | 	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
231 | 	if errorlevel 1 exit /b 1
232 | 	echo.
233 | 	echo.Testing of doctests in the sources finished, look at the ^
234 | results in %BUILDDIR%/doctest/output.txt.
235 | 	goto end
236 | )
237 | 
238 | if "%1" == "coverage" (
239 | 	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
240 | 	if errorlevel 1 exit /b 1
241 | 	echo.
242 | 	echo.Testing of coverage in the sources finished, look at the ^
243 | results in %BUILDDIR%/coverage/python.txt.
244 | 	goto end
245 | )
246 | 
247 | if "%1" == "xml" (
248 | 	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
249 | 	if errorlevel 1 exit /b 1
250 | 	echo.
251 | 	echo.Build finished. The XML files are in %BUILDDIR%/xml.
252 | 	goto end
253 | )
254 | 
255 | if "%1" == "pseudoxml" (
256 | 	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
257 | 	if errorlevel 1 exit /b 1
258 | 	echo.
259 | 	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
260 | 	goto end
261 | )
262 | 
263 | :end
264 | 


--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | sphinx==4.4.0
2 | sphinxcontrib_trio==1.1.2
3 | sphinxcontrib-websupport
4 | typing-extensions
5 | 


--------------------------------------------------------------------------------
/github/__init__.py:
--------------------------------------------------------------------------------
 1 | # == __init__.py ==#
 2 | 
 3 | __title__ = 'Github-Api-Wrapper'
 4 | __authors__ = 'VarMonke', 'sudosnok'
 5 | __version__ = '1.2.7'
 6 | __license__ = 'MIT'
 7 | __copyright__ = 'Copyright (c) 2022-present VarMonke & sudosnok'
 8 | 
 9 | from .client import *
10 | from .exceptions import *
11 | from .http import *
12 | from .objects import *
13 | from .urls import *
14 | 


--------------------------------------------------------------------------------
/github/cache.py:
--------------------------------------------------------------------------------
 1 | # == cache.py ==#
 2 | 
 3 | from __future__ import annotations
 4 | 
 5 | from collections import deque
 6 | from typing import Any, Deque, Dict, Tuple, TypeVar
 7 | 
 8 | __all__: Tuple[str, ...] = ('ObjectCache',)
 9 | 
10 | 
11 | K = TypeVar('K')
12 | V = TypeVar('V')
13 | 
14 | 
15 | class _BaseCache(Dict[K, V]):
16 |     """This is a rough implementation of an LRU Cache using a deque and a dict."""
17 | 
18 |     __slots__: Tuple[str, ...] = ('_max_size', '_lru_keys')
19 | 
20 |     def __init__(self, max_size: int, *args: Any) -> None:
21 |         self._max_size: int = max(min(max_size, 30), 0)  # bounding max_size to 15 for now
22 |         self._lru_keys: Deque[K] = deque(maxlen=self._max_size)
23 |         super().__init__(*args)
24 | 
25 |     def __getitem__(self, __k: K) -> V:
26 |         index = self._lru_keys.index(__k)
27 |         target = self._lru_keys[index]
28 |         del self._lru_keys[index]
29 | 
30 |         self._lru_keys.appendleft(target)
31 |         return super().__getitem__(__k)
32 | 
33 |     def __setitem__(self, __k: K, __v: V) -> None:
34 |         if len(self) == self._max_size:
35 |             self.__delitem__(self._lru_keys.pop())
36 | 
37 |         self._lru_keys.appendleft(__k)
38 |         return super().__setitem__(__k, __v)
39 | 
40 |     def update(self, **kwargs: Any) -> None:
41 |         for key, value in dict(**kwargs).items():
42 |             key: K
43 |             value: V
44 | 
45 |             self.__setitem__(key, value)
46 | 
47 | 
48 | class ObjectCache(_BaseCache[K, V]):
49 |     """This adjusts the typehints to reflect Github objects."""
50 | 
51 |     def __getitem__(self, __k: K) -> V:
52 |         index = self._lru_keys.index(__k)
53 |         target = self._lru_keys[index]
54 |         self._lru_keys.appendleft(target)
55 |         return super().__getitem__(__k)
56 | 
57 |     def __setitem__(self, __k: K, __v: V) -> None:
58 |         if self.__len__() == self._max_size:
59 |             self.__delitem__(self._lru_keys.pop())
60 | 
61 |         self._lru_keys.appendleft(__k)
62 |         return super().__setitem__(__k, __v)
63 | 
64 |     def update(self, **kwargs: Any) -> None:
65 |         for key, value in dict(**kwargs).items():
66 |             key: K
67 |             value: V
68 | 
69 |             self.__setitem__(key, value)
70 | 


--------------------------------------------------------------------------------
/github/client.py:
--------------------------------------------------------------------------------
  1 | # == main.py ==#
  2 | from __future__ import annotations
  3 | 
  4 | import functools
  5 | from typing import (
  6 |     Any,
  7 |     Awaitable,
  8 |     Callable,
  9 |     Coroutine,
 10 |     Dict,
 11 |     Generator,
 12 |     List,
 13 |     Literal,
 14 |     Optional,
 15 |     Tuple,
 16 |     TypeVar,
 17 |     Union,
 18 |     overload,
 19 | )
 20 | 
 21 | import aiohttp
 22 | from typing_extensions import Concatenate, ParamSpec, Self
 23 | 
 24 | from . import exceptions
 25 | from .cache import ObjectCache
 26 | from .http import http
 27 | from .objects import File, Gist, Issue, Organization, Repository, User
 28 | 
 29 | __all__: Tuple[str, ...] = ('GHClient', 'Client')
 30 | 
 31 | T = TypeVar('T')
 32 | P = ParamSpec('P')
 33 | 
 34 | 
 35 | class GHClient:
 36 |     """The main client, used to start most use-cases.
 37 | 
 38 |     Parameters
 39 |     ----------
 40 |     username: Optional[:class:`str`]
 41 |         An optional username to be provided along with a token to make authenticated API calls.
 42 |         If you provide a username, the token must be provided as well.
 43 |     user_cache_size: Optional[:class:`int`]
 44 |         Determines the maximum number of User objects that will be cached in memory.
 45 |         Defaults to 30, must be between 30 and 0 inclusive.
 46 |     repo_cache_size: Optional[:class:`int`]
 47 |         Determines the maximum number of Repository objects that will be cached in memory.
 48 |         Defaults to 15, must be between 30 and 0 inclusive.
 49 |     custom_headers: Optional[:class:`dict`]
 50 |         A way to pass custom headers into the client session that drives the client, eg. a user-agent.
 51 | 
 52 |     Attributes
 53 |     ----------
 54 |     username: Optional[:class:`str`]
 55 |         The authenticated Client's username, if applicable.
 56 |     __token: Optional[:class:`str`]
 57 |         The authenticated Client's token, if applicable.
 58 |     """
 59 | 
 60 |     has_started: bool = False
 61 | 
 62 |     def __init__(
 63 |         self,
 64 |         *,
 65 |         username: Optional[str] = None,
 66 |         token: Optional[str] = None,
 67 |         user_cache_size: int = 30,
 68 |         repo_cache_size: int = 15,
 69 |         custom_headers: Dict[str, Union[str, int]] = {},
 70 |     ):
 71 |         self._headers = custom_headers
 72 | 
 73 |         if username and token:
 74 |             self.username = username
 75 |             self.__token = token
 76 |             self.__auth = aiohttp.BasicAuth(username, token)
 77 |         else:
 78 |             self.__auth = None
 79 |             self.username = None
 80 |             self.__token = None
 81 | 
 82 |         self.http = http(headers=custom_headers, auth=self.__auth)
 83 | 
 84 |         self._user_cache = ObjectCache[Any, User](user_cache_size)
 85 |         self._repo_cache = ObjectCache[Any, Repository](repo_cache_size)
 86 | 
 87 |         # Cache manegent
 88 |         self._cache(type='user')(self.get_self)  # type: ignore
 89 |         self._cache(type='user')(self.get_user)  # type: ignore
 90 |         self._cache(type='repo')(self.get_repo)  # type: ignore
 91 | 
 92 |     def __call__(self, *args: Any, **kwargs: Any) -> Coroutine[Any, Any, Self]:
 93 |         return self.start(*args, **kwargs)
 94 | 
 95 |     def __await__(self) -> Generator[Any, Any, Self]:
 96 |         return self.start().__await__()
 97 | 
 98 |     async def __aenter__(self) -> Self:
 99 |         await self.start()
100 |         return self
101 | 
102 |     async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
103 |         try:
104 |             session = self.http.session
105 |             await session.close()
106 |         except Exception as exc:
107 |             raise Exception('HTTP Session doesn\'t exist') from exc
108 | 
109 |     def __repr__(self) -> str:
110 |         return f'<Client has_auth={bool(self.__auth)}>'
111 | 
112 |     @overload
113 |     def check_limits(self, as_dict: Literal[True] = True) -> Dict[str, Union[str, int]]: ...
114 | 
115 |     @overload
116 |     def check_limits(self, as_dict: Literal[False] = False) -> List[str]: ...
117 | 
118 |     def check_limits(self, as_dict: bool = False) -> Union[Dict[str, Union[str, int]], List[str]]:
119 |         """Returns the remaining number of API calls per timeframe.
120 | 
121 |         Parameters
122 |         ----------
123 |         as_dict: Optional[:class:`bool`]
124 |             Set to True to return the remaining calls in a dictionary.
125 |             Set to False to return the remaining calls in a list.
126 |             Defaults to False
127 |         """
128 |         if not self.has_started:
129 |             raise exceptions.NotStarted
130 |         if not as_dict:
131 |             output: List[str] = []
132 |             for key, value in self.http.session._rates._asdict().items():  # type: ignore
133 |                 output.append(f"{key} : {value}")
134 | 
135 |             return output
136 | 
137 |         return self.http.session._rates  # type: ignore
138 | 
139 |     async def update_auth(self, *, username: str, token: str) -> None:
140 |         """Allows you to input auth information after instantiating the client.
141 | 
142 |         Parameters
143 |         ----------
144 |         username: :class:`str`
145 |             The username to update the authentication to.
146 |             Must also be provided with the valid token.
147 |         token: :class:`str`
148 |             The token to update the authentication to.
149 |             Must also be providede with the valid username.
150 |         """
151 |         # check if username and token is valid
152 |         await self.http.update_auth(username=username, token=token)
153 |         try:
154 |             await self.http.get_self()
155 |         except exceptions.InvalidToken as exc:
156 |             raise exceptions.InvalidToken from exc
157 | 
158 |     async def start(self) -> Self:
159 |         """Main entry point to the wrapper, this creates the ClientSession.
160 | 
161 |         Parameters
162 |         ----------
163 |         """
164 |         if self.has_started:
165 |             raise exceptions.AlreadyStarted
166 |         if self.__auth:
167 |             self.http = await http(auth=self.__auth, headers=self._headers)
168 |             try:
169 |                 await self.http.get_self()
170 |             except exceptions.InvalidToken as exc:
171 |                 raise exceptions.InvalidToken from exc
172 |         else:
173 |             self.http = await http(auth=None, headers=self._headers)
174 |         self.has_started = True
175 |         return self
176 | 
177 |     def _cache(self: Self, *, type: str) -> Callable[
178 |         [Callable[Concatenate[Self, P], Awaitable[T]]],
179 |         Callable[Concatenate[Self, P], Awaitable[Optional[Union[T, User, Repository]]]],
180 |     ]:
181 |         def wrapper(
182 |             func: Callable[Concatenate[Self, P], Awaitable[T]],
183 |         ) -> Callable[Concatenate[Self, P], Awaitable[Optional[Union[T, User, Repository]]]]:
184 |             @functools.wraps(func)
185 |             async def wrapped(self: Self, *args: P.args, **kwargs: P.kwargs) -> Optional[Union[T, User, Repository]]:
186 |                 if type == 'user':
187 |                     obj = self._user_cache.get(kwargs.get('user'))
188 |                     if obj:
189 |                         return obj
190 | 
191 |                     user: User = await func(self, *args, **kwargs)  # type: ignore
192 |                     self._user_cache[kwargs.get("user")] = user
193 |                     return user
194 |                 if type == 'repo':
195 |                     obj = self._repo_cache.get(kwargs.get('repo'))
196 |                     if obj:
197 |                         return obj
198 | 
199 |                     repo: Repository = await func(self, *args, **kwargs)  # type: ignore
200 |                     self._repo_cache[kwargs.get('repo')] = repo
201 |                     return repo
202 | 
203 |             return wrapped
204 | 
205 |         return wrapper
206 | 
207 |     # @_cache(type='User')
208 |     async def get_self(self) -> User:
209 |         """:class:`User`: Returns the authenticated User object."""
210 |         if self.__auth:
211 |             return User(await self.http.get_self(), self.http)
212 |         else:
213 |             raise exceptions.NoAuthProvided
214 | 
215 |     async def get_user(self, *, user: str) -> User:
216 |         """:class:`User`: Fetch a Github user from their username.
217 | 
218 |         Parameters
219 |         ----------
220 |         user: :class:`str`
221 |             The name of the user to fetch.
222 |         """
223 |         return User(await self.http.get_user(user), self.http)
224 | 
225 |     async def get_repo(self, *, owner: str, repo: str) -> Repository:
226 |         """:class:`Repository`: Fetch a Github repository from it's name.
227 | 
228 |         Parameters
229 |         ----------
230 |         owner: :class:`str`
231 |             The name of the owner of a given reposiory.
232 |         repo: :class:`str`
233 |             The name of the repository to fetch.
234 |         """
235 |         return Repository(await self.http.get_repo(owner, repo), self.http)  # type: ignore
236 | 
237 |     async def get_issue(self, *, owner: str, repo: str, issue: int) -> Issue:
238 |         """:class:`Issue`: Fetch a Github Issue from it's name.
239 | 
240 |         Parameters
241 |         ----------
242 |         owner: :class:`str`
243 |             The name of the owner of the repository for which the issue relates to.
244 |         repo: :class:`str`
245 |             The name of the repository to which the issue is related to.
246 |         issue: :class:`int`
247 |             The ID of the issue to fetch.
248 |         """
249 |         return Issue(await self.http.get_repo_issue(owner, repo, issue), self.http)  # type: ignore #fwiw, this shouldn't error but pyright <3
250 | 
251 |     async def create_repo(
252 |         self,
253 |         name: str,
254 |         description: str = 'Repository created using Github-Api-Wrapper.',
255 |         public: bool = False,
256 |         gitignore: Optional[str] = None,
257 |         license: Optional[str] = None,
258 |     ) -> Repository:
259 |         """Creates a Repository with supplied data.
260 |         Requires API authentication.
261 | 
262 |         Parameters
263 |         ----------
264 |         name: :class:`str`
265 |             The name of the repository to be created.
266 |         description: :class:`str`
267 |             A description of the repository to be created.
268 |         public: :class:`bool`
269 |             Determines whether only the repository will be visible to the public.
270 |             Defaults to False (private repository).
271 |         gitignore: Optional[:class:`str`]
272 |             .gitignore template to use.
273 |             See https://github.com/github/gitignore for GitHub's own templates.
274 |             Defaults to None.
275 |         license: Optional[:class:`str`]
276 |             TODO: Document this.
277 | 
278 |         Returns
279 |         -------
280 |         :class:`Repository`
281 |         """
282 |         return Repository(
283 |             await self.http.create_repo(name, description, public, gitignore, license),
284 |             self.http,
285 |         )
286 | 
287 |     async def delete_repo(self, repo: str) -> Optional[str]:
288 |         """Delete a Github repository, requires authorisation.
289 | 
290 |         Parameters
291 |         ----------
292 |         repo: :class:`str`
293 |             The name of the repository to delete.
294 | 
295 |         Returns
296 |         -------
297 |         Optional[:class:`str`]
298 |         """
299 |         return await self.http.delete_repo(self.username, repo)
300 | 
301 |     async def get_gist(self, gist: str) -> Gist:
302 |         """Fetch a Github gist from it's id.
303 | 
304 |         Parameters
305 |         ----------
306 |         gist: :class:`str`
307 |             The id of the gist to fetch.
308 | 
309 |         Returns
310 |         -------
311 |         :class:`Gist`
312 |         """
313 |         return Gist(await self.http.get_gist(gist), self.http)
314 | 
315 |     async def create_gist(
316 |         self, *, files: List[File], description: str = 'Gist from Github-Api-Wrapper', public: bool = True
317 |     ) -> Gist:
318 |         """Creates a Gist with the given files, requires authorisation.
319 | 
320 |         Parameters
321 |         ----------
322 |         files: List[:class:`File`]
323 |             A list of File objects to upload to the gist.
324 |         description: :class:`str`
325 |             A description of the gist.
326 |         public: :class:`bool`
327 |             Determines whether the gist will be visible to the public.
328 |             Defaults to False (private).
329 | 
330 |         Returns
331 |         -------
332 |         :class:`Gist`
333 |         """
334 |         return Gist(
335 |             await self.http.create_gist(files=files, description=description, public=public),
336 |             self.http,
337 |         )
338 | 
339 |     async def delete_gist(self, gist: int) -> Optional[str]:
340 |         """Delete a Github gist, requires authorisation.
341 | 
342 |         Parameters
343 |         ----------
344 |         gist: :class:`int`
345 |             The ID of the gist to delete.
346 | 
347 |         Returns
348 |         -------
349 |         Optional[:class:`str`]
350 |         """
351 |         return await self.http.delete_gist(gist)
352 | 
353 |     async def get_org(self, org: str) -> Organization:
354 |         """Fetch a Github organization from it's name.
355 | 
356 |         Parameters
357 |         ----------
358 |         org: :class:`str`
359 |             The name of the organization to fetch.
360 | 
361 |         Returns
362 |         -------
363 |         :class:`Organization`
364 |         """
365 |         return Organization(await self.http.get_org(org), self.http)
366 | 
367 |     async def latency(self) -> float:
368 |         """:class:`float`: Returns the latency of the client."""
369 |         return await self.http.latency()
370 | 
371 |     async def close(self) -> None:
372 |         """Close the session."""
373 |         await self.http.session.close()
374 | 
375 | 
376 | class Client(GHClient):
377 |     pass
378 | 


--------------------------------------------------------------------------------
/github/exceptions.py:
--------------------------------------------------------------------------------
  1 | # == exceptions.py ==#
  2 | 
  3 | import datetime
  4 | from typing import Optional, Tuple
  5 | 
  6 | from aiohttp import ClientResponse
  7 | 
  8 | __all__: Tuple[str, ...] = (
  9 |     'APIError',
 10 |     'AlreadyStarted',
 11 |     'ClientException',
 12 |     'ClientResponse',
 13 |     'GistNotFound',
 14 |     'HTTPException',
 15 |     'InvalidAuthCombination',
 16 |     'InvalidToken',
 17 |     'IssueNotFound',
 18 |     'LoginFailure',
 19 |     'MissingPermissions',
 20 |     'NoAuthProvided',
 21 |     'NotStarted',
 22 |     'OrganizationNotFound',
 23 |     'Ratelimited',
 24 |     'RepositoryAlreadyExists',
 25 |     'RepositoryNotFound',
 26 |     'ResourceAlreadyExists',
 27 |     'ResourceNotFound',
 28 |     'UserNotFound',
 29 |     'WillExceedRatelimit',
 30 | )
 31 | 
 32 | 
 33 | class APIError(Exception):
 34 |     """Base level exceptions raised by errors related to any API request or call."""
 35 | 
 36 |     pass
 37 | 
 38 | 
 39 | class HTTPException(Exception):
 40 |     """Base level exceptions raised by errors related to HTTP requests."""
 41 | 
 42 |     pass
 43 | 
 44 | 
 45 | class ClientException(Exception):
 46 |     """Base level exceptions raised by errors related to the client."""
 47 | 
 48 |     pass
 49 | 
 50 | 
 51 | class ResourceNotFound(Exception):
 52 |     """Base level exceptions raised when a resource is not found."""
 53 | 
 54 |     pass
 55 | 
 56 | 
 57 | class ResourceAlreadyExists(Exception):
 58 |     """Base level exceptions raised when a resource already exists."""
 59 | 
 60 |     pass
 61 | 
 62 | 
 63 | class Ratelimited(APIError):
 64 |     """Raised when the ratelimit from Github is reached or exceeded."""
 65 | 
 66 |     def __init__(self, reset_time: datetime.datetime):
 67 |         formatted = reset_time.strftime(r"%H:%M:%S %A, %d %b")
 68 |         msg = f"We're being ratelimited, wait until {formatted}.\nAuthentication raises the ratelimit."
 69 |         super().__init__(msg)
 70 | 
 71 | 
 72 | class WillExceedRatelimit(APIError):
 73 |     """Raised when the library predicts the call will exceed the ratelimit, will abort the call by default."""
 74 | 
 75 |     def __init__(self, response: ClientResponse, count: int):
 76 |         msg = 'Performing this action will exceed the ratelimit, aborting.\n{} remaining available calls, calls to make: {}.'
 77 |         msg = msg.format(response.headers['X-RateLimit-Remaining'], count)
 78 |         super().__init__(msg)
 79 | 
 80 | 
 81 | class NoAuthProvided(ClientException):
 82 |     """Raised when no authentication is provided."""
 83 | 
 84 |     def __init__(self):
 85 |         msg = 'This action required autentication. Pass username and token kwargs to your client instance.'
 86 |         super().__init__(msg)
 87 | 
 88 | 
 89 | class InvalidToken(ClientException):
 90 |     """Raised when the token provided is invalid."""
 91 | 
 92 |     def __init__(self):
 93 |         msg = 'The token provided is invalid.'
 94 |         super().__init__(msg)
 95 | 
 96 | 
 97 | class InvalidAuthCombination(ClientException):
 98 |     """Raised when the username and token are both provided."""
 99 | 
100 |     def __init__(self, msg: str):
101 |         # msg = 'The username and token cannot be used together.'
102 |         super().__init__(msg)
103 | 
104 | 
105 | class LoginFailure(ClientException):
106 |     """Raised when the login attempt fails."""
107 | 
108 |     def __init__(self):
109 |         msg = 'The login attempt failed. Provide valid credentials.'
110 |         super().__init__(msg)
111 | 
112 | 
113 | class NotStarted(ClientException):
114 |     """Raised when the client is not started."""
115 | 
116 |     def __init__(self):
117 |         msg = 'The client is not started. Run Github.GHClient() to start.'
118 |         super().__init__(msg)
119 | 
120 | 
121 | class AlreadyStarted(ClientException):
122 |     """Raised when the client is already started."""
123 | 
124 |     def __init__(self):
125 |         msg = 'The client is already started.'
126 |         super().__init__(msg)
127 | 
128 | 
129 | class MissingPermissions(APIError):
130 |     def __init__(self):
131 |         msg = 'You do not have permissions to perform this action.'
132 |         super().__init__(msg)
133 | 
134 | 
135 | class UserNotFound(ResourceNotFound):
136 |     def __init__(self):
137 |         msg = 'The requested user was not found.'
138 |         super().__init__(msg)
139 | 
140 | 
141 | class RepositoryNotFound(ResourceNotFound):
142 |     def __init__(self):
143 |         msg = 'The requested repository is either private or does not exist.'
144 |         super().__init__(msg)
145 | 
146 | 
147 | class IssueNotFound(ResourceNotFound):
148 |     def __init__(self):
149 |         msg = 'The requested issue was not found.'
150 |         super().__init__(msg)
151 | 
152 | 
153 | class OrganizationNotFound(ResourceNotFound):
154 |     def __init__(self):
155 |         msg = 'The requested organization was not found.'
156 |         super().__init__(msg)
157 | 
158 | 
159 | class GistNotFound(ResourceNotFound):
160 |     def __init__(self):
161 |         msg = 'The requested gist was not found.'
162 |         super().__init__(msg)
163 | 
164 | 
165 | class RepositoryAlreadyExists(ResourceAlreadyExists):
166 |     def __init__(self):
167 |         msg = 'The requested repository already exists.'
168 |         super().__init__(msg)
169 | 
170 | 
171 | class FileAlreadyExists(ResourceAlreadyExists):
172 |     def __init__(self, msg: Optional[str] = None):
173 |         if msg is None:
174 |             msg = 'The requested file already exists.'
175 |         super().__init__(msg)
176 | 


--------------------------------------------------------------------------------
/github/http.py:
--------------------------------------------------------------------------------
  1 | # == http.py ==#
  2 | 
  3 | from __future__ import annotations
  4 | 
  5 | import json
  6 | import platform
  7 | import re
  8 | from datetime import datetime
  9 | from types import SimpleNamespace
 10 | from typing import Any, Dict, List, NamedTuple, Optional, Tuple, Type, Union
 11 | 
 12 | import aiohttp
 13 | from typing_extensions import TypeAlias
 14 | 
 15 | from . import __version__
 16 | from .exceptions import *
 17 | from .objects import File, Gist, Repository, User, bytes_to_b64
 18 | from .urls import *
 19 | 
 20 | __all__: Tuple[str, ...] = (
 21 |     'Paginator',
 22 |     'http',
 23 | )
 24 | 
 25 | 
 26 | LINK_PARSING_RE = re.compile(r"<(\S+(\S))>; rel=\"(\S+)\"")
 27 | 
 28 | 
 29 | class Rates(NamedTuple):
 30 |     remaining: str
 31 |     used: str
 32 |     total: str
 33 |     reset_when: Union[datetime, str]
 34 |     last_request: Union[datetime, str]
 35 | 
 36 | 
 37 | # aiohttp request tracking / checking bits
 38 | async def on_req_start(
 39 |     session: aiohttp.ClientSession, ctx: SimpleNamespace, params: aiohttp.TraceRequestStartParams
 40 | ) -> None:
 41 |     """Before-request hook to make sure we don't overrun the ratelimit."""
 42 |     # print(repr(session), repr(ctx), repr(params))
 43 |     if session._rates.remaining in ('0', '1'):  # type: ignore
 44 |         raise Exception('Ratelimit exceeded')
 45 | 
 46 | 
 47 | async def on_req_end(session: aiohttp.ClientSession, ctx: SimpleNamespace, params: aiohttp.TraceRequestEndParams) -> None:
 48 |     """After-request hook to adjust remaining requests on this time frame."""
 49 |     headers = params.response.headers
 50 | 
 51 |     remaining = headers['X-RateLimit-Remaining']
 52 |     used = headers['X-RateLimit-Used']
 53 |     total = headers['X-RateLimit-Limit']
 54 |     reset_when = datetime.fromtimestamp(int(headers['X-RateLimit-Reset']))
 55 |     last_req = datetime.utcnow()
 56 | 
 57 |     session._rates = Rates(remaining, used, total, reset_when, last_req)
 58 | 
 59 | 
 60 | trace_config = aiohttp.TraceConfig()
 61 | trace_config.on_request_start.append(on_req_start)
 62 | trace_config.on_request_end.append(on_req_end)
 63 | 
 64 | APIType: TypeAlias = Union[User, Gist, Repository]
 65 | 
 66 | 
 67 | async def make_session(*, headers: Dict[str, str], authorization: Union[aiohttp.BasicAuth, None]) -> aiohttp.ClientSession:
 68 |     """This makes the ClientSession, attaching the trace config and ensuring a UA header is present."""
 69 |     if not headers.get('User-Agent'):
 70 |         headers['User-Agent'] = (
 71 |             f'Github-API-Wrapper (https://github.com/VarMonke/Github-Api-Wrapper) @ {__version__} Python'
 72 |             f' {platform.python_version()} aiohttp {aiohttp.__version__}'
 73 |         )
 74 | 
 75 |     session = aiohttp.ClientSession(auth=authorization, headers=headers, trace_configs=[trace_config])
 76 |     session._rates = Rates('', '', '', '', '')
 77 |     return session
 78 | 
 79 | 
 80 | # pagination
 81 | class Paginator:
 82 |     """This class handles pagination for objects like Repos and Orgs."""
 83 | 
 84 |     def __init__(self, session: aiohttp.ClientSession, response: aiohttp.ClientResponse, target_type: str):
 85 |         self.session = session
 86 |         self.response = response
 87 |         self.should_paginate = bool(self.response.headers.get('Link', False))
 88 |         types: Dict[str, Type[APIType]] = {  # note: the type checker doesnt see subclasses like that
 89 |             'user': User,
 90 |             'gist': Gist,
 91 |             'repo': Repository,
 92 |         }
 93 |         self.target_type: Type[APIType] = types[target_type]
 94 |         self.pages = {}
 95 |         self.is_exhausted = False
 96 |         self.current_page = 1
 97 |         self.next_page = self.current_page + 1
 98 |         self.parse_header(response)
 99 | 
100 |     async def fetch_page(self, link: str) -> Dict[str, Union[str, int]]:
101 |         """Fetches a specific page and returns the JSON."""
102 |         return await (await self.session.get(link)).json()
103 | 
104 |     async def early_return(self) -> List[APIType]:
105 |         # I don't rightly remember what this does differently, may have a good ol redesign later
106 |         return [self.target_type(data, self) for data in await self.response.json()]  # type: ignore
107 | 
108 |     async def exhaust(self) -> List[APIType]:
109 |         """Iterates through all of the pages for the relevant object and creates them."""
110 |         if self.should_paginate:
111 |             return await self.early_return()
112 | 
113 |         out: List[APIType] = []
114 |         for page in range(1, self.max_page + 1):
115 |             result = await self.session.get(self.bare_link + str(page))
116 |             out.extend([self.target_type(item, self) for item in await result.json()])  # type: ignore
117 | 
118 |         self.is_exhausted = True
119 |         return out
120 | 
121 |     def parse_header(self, response: aiohttp.ClientResponse) -> None:
122 |         """Predicts wether a call will exceed the ratelimit ahead of the call."""
123 |         header = response.headers['Link']
124 |         groups = LINK_PARSING_RE.findall(header)
125 |         self.max_page = int(groups[1][1])
126 |         if int(response.headers['X-RateLimit-Remaining']) < self.max_page:
127 |             raise WillExceedRatelimit(response, self.max_page)
128 |         self.bare_link = groups[0][0][:-1]
129 | 
130 | 
131 | # GithubUserData = GithubRepoData = GithubIssueData = GithubOrgData = GithubGistData = Dict[str, Union [str, int]]
132 | # Commentnig this out for now, consider using TypeDict's instead in the future <3
133 | 
134 | 
135 | class http:
136 |     def __init__(self, headers: Dict[str, Union[str, int]], auth: Union[aiohttp.BasicAuth, None]) -> None:
137 |         if not headers.get('User-Agent'):
138 |             headers['User-Agent'] = (
139 |                 'Github-API-Wrapper (https://github.com/VarMonke/Github-Api-Wrapper) @'
140 |                 f' {__version__} Python/{platform.python_version()} aiohttp/{aiohttp.__version__}'
141 |             )
142 | 
143 |         self._rates = Rates('', '', '', '', '')
144 |         self.headers = headers
145 |         self.auth = auth
146 | 
147 |     def __await__(self):
148 |         return self.start().__await__()
149 | 
150 |     async def start(self):
151 |         self.session = aiohttp.ClientSession(
152 |             headers=self.headers,  # type: ignore
153 |             auth=self.auth,
154 |             trace_configs=[trace_config],
155 |         )
156 |         if not hasattr(self.session, "_rates"):
157 |             self.session._rates = Rates('', '', '', '', '')
158 |         return self
159 | 
160 |     def update_headers(self, *, flush: bool = False, new_headers: Dict[str, Union[str, int]]):
161 |         if flush:
162 |             from multidict import CIMultiDict
163 | 
164 |             self.session._default_headers = CIMultiDict(**new_headers)  # type: ignore
165 |         else:
166 |             self.session._default_headers = {**self.session.headers, **new_headers}  # type: ignore
167 | 
168 |     async def update_auth(self, *, username: str, token: str):
169 |         auth = aiohttp.BasicAuth(username, token)
170 |         headers = self.session.headers
171 |         config = self.session.trace_configs
172 |         await self.session.close()
173 |         self.session = aiohttp.ClientSession(headers=headers, auth=auth, trace_configs=config)
174 | 
175 |     def data(self):
176 |         # return session headers and auth
177 |         headers = {**self.session.headers}
178 |         return {'headers': headers, 'auth': self.auth}
179 | 
180 |     async def latency(self):
181 |         """Returns the latency of the current session."""
182 |         start = datetime.utcnow()
183 |         await self.session.get(BASE_URL)
184 |         return (datetime.utcnow() - start).total_seconds()
185 | 
186 |     async def get_self(self) -> Dict[str, Union[str, int]]:
187 |         """Returns the authenticated User's data"""
188 |         result = await self.session.get(SELF_URL)
189 |         if 200 <= result.status <= 299:
190 |             return await result.json()
191 |         raise InvalidToken
192 | 
193 |     async def get_user(self, username: str) -> Dict[str, Union[str, int]]:
194 |         """Returns a user's public data in JSON format."""
195 |         result = await self.session.get(USERS_URL.format(username))
196 |         if 200 <= result.status <= 299:
197 |             return await result.json()
198 |         raise UserNotFound
199 | 
200 |     async def get_user_repos(self, _user: User) -> List[Dict[str, Union[str, int]]]:
201 |         result = await self.session.get(USER_REPOS_URL.format(_user.login))
202 |         if 200 <= result.status <= 299:
203 |             return await result.json()
204 | 
205 |         print('This shouldn\'t be reachable')
206 |         return []
207 | 
208 |     async def get_user_gists(self, _user: User) -> List[Dict[str, Union[str, int]]]:
209 |         result = await self.session.get(USER_GISTS_URL.format(_user.login))
210 |         if 200 <= result.status <= 299:
211 |             return await result.json()
212 | 
213 |         print('This shouldn\'t be reachable')
214 |         return []
215 | 
216 |     async def get_user_orgs(self, _user: User) -> List[Dict[str, Union[str, int]]]:
217 |         result = await self.session.get(USER_ORGS_URL.format(_user.login))
218 |         if 200 <= result.status <= 299:
219 |             return await result.json()
220 | 
221 |         print('This shouldn\'t be reachable')
222 |         return []
223 | 
224 |     async def get_repo(self, owner: str, repo_name: str) -> Optional[Dict[str, Union[str, int]]]:
225 |         """Returns a Repo's raw JSON from the given owner and repo name."""
226 |         result = await self.session.get(REPO_URL.format(owner, repo_name))
227 |         if 200 <= result.status <= 299:
228 |             return await result.json()
229 |         raise RepositoryNotFound
230 | 
231 |     async def get_repo_issue(self, owner: str, repo_name: str, issue_number: int) -> Optional[Dict[str, Any]]:
232 |         """Returns a single issue's JSON from the given owner and repo name."""
233 |         result = await self.session.get(REPO_ISSUE_URL.format(owner, repo_name, issue_number))
234 |         if 200 <= result.status <= 299:
235 |             return await result.json()
236 |         raise IssueNotFound
237 | 
238 |     async def delete_repo(self, owner: Optional[str], repo_name: str) -> Optional[str]:
239 |         """Deletes a Repo from the given owner and repo name."""
240 |         result = await self.session.delete(REPO_URL.format(owner, repo_name))
241 |         if 204 <= result.status <= 299:
242 |             return 'Successfully deleted repository.'
243 |         if result.status == 403:  # type: ignore
244 |             raise MissingPermissions
245 |         raise RepositoryNotFound
246 | 
247 |     async def delete_gist(self, gist_id: Union[str, int]) -> Optional[str]:
248 |         """Deletes a Gist from the given gist id."""
249 |         result = await self.session.delete(GIST_URL.format(gist_id))
250 |         if result.status == 204:
251 |             return 'Successfully deleted gist.'
252 |         if result.status == 403:
253 |             raise MissingPermissions
254 |         raise GistNotFound
255 | 
256 |     async def get_org(self, org_name: str) -> Dict[str, Union[str, int]]:
257 |         """Returns an org's public data in JSON format."""  # type: ignore
258 |         result = await self.session.get(ORG_URL.format(org_name))
259 |         if 200 <= result.status <= 299:
260 |             return await result.json()
261 |         raise OrganizationNotFound
262 | 
263 |     async def get_gist(self, gist_id: str) -> Dict[str, Union[str, int]]:
264 |         """Returns a gist's raw JSON from the given gist id."""
265 |         result = await self.session.get(GIST_URL.format(gist_id))
266 |         if 200 <= result.status <= 299:
267 |             return await result.json()
268 |         raise GistNotFound
269 | 
270 |     async def create_gist(
271 |         self, *, files: List['File'] = [], description: str = 'Default description', public: bool = False
272 |     ) -> Dict[str, Union[str, int]]:
273 |         data = {}
274 |         data['description'] = description
275 |         data['public'] = public
276 |         data['files'] = {}
277 |         for file in files:
278 |             data['files'][file.filename] = {'filename': file.filename, 'content': file.read()}  # helps editing the file
279 |         data = json.dumps(data)
280 |         _headers = dict(self.session.headers)
281 |         result = await self.session.post(CREATE_GIST_URL, data=data, headers=_headers)
282 |         if 201 == result.status:
283 |             return await result.json()
284 |         raise InvalidToken
285 | 
286 |     async def create_repo(
287 |         self, name: str, description: str, public: bool, gitignore: Optional[str], license: Optional[str]
288 |     ) -> Dict[str, Union[str, int]]:
289 |         """Creates a repo for you with given data"""
290 |         data = {
291 |             'name': name,
292 |             'description': description,
293 |             'public': public,
294 |             'gitignore_template': gitignore,
295 |             'license': license,
296 |         }
297 |         result = await self.session.post(CREATE_REPO_URL, data=json.dumps(data))
298 |         if 200 <= result.status <= 299:
299 |             return await result.json()
300 |         if result.status == 401:
301 |             raise NoAuthProvided
302 |         raise RepositoryAlreadyExists
303 | 
304 |     async def add_file(self, owner: str, repo_name: str, filename: str, content: str, message: str, branch: str):
305 |         """Adds a file to the given repo."""
306 | 
307 |         data = {
308 |             'content': bytes_to_b64(content=content),
309 |             'message': message,
310 |             'branch': branch,
311 |         }
312 | 
313 |         result = await self.session.put(ADD_FILE_URL.format(owner, repo_name, filename), data=json.dumps(data))
314 |         if 200 <= result.status <= 299:
315 |             return await result.json()
316 |         if result.status == 401:
317 |             raise NoAuthProvided
318 |         if result.status == 409:
319 |             raise FileAlreadyExists
320 |         if result.status == 422:
321 |             raise FileAlreadyExists('This file exists, and can only be edited.')
322 |         return await result.json(), result.status
323 | 


--------------------------------------------------------------------------------
/github/objects.py:
--------------------------------------------------------------------------------
  1 | # == objects.py ==#
  2 | from __future__ import annotations
  3 | 
  4 | from base64 import b64encode
  5 | from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
  6 | 
  7 | if TYPE_CHECKING:
  8 |     from .http import http
  9 | 
 10 | import io
 11 | import os
 12 | from datetime import datetime
 13 | 
 14 | __all__: Tuple[str, ...] = (
 15 |     'APIObject',
 16 |     'dt_formatter',
 17 |     'repr_dt',
 18 |     'PartialUser',
 19 |     'User',
 20 |     'Repository',
 21 |     'Issue',
 22 |     'File',
 23 |     'Gist',
 24 |     'Organization',
 25 | )
 26 | 
 27 | 
 28 | def dt_formatter(time_str: Optional[str]) -> Optional[datetime]:
 29 |     if time_str is not None:
 30 |         return datetime.strptime(time_str, r"%Y-%m-%dT%H:%M:%SZ")
 31 | 
 32 |     return None
 33 | 
 34 | 
 35 | def repr_dt(_datetime: datetime) -> str:
 36 |     return _datetime.strftime(r'%d-%m-%Y, %H:%M:%S')
 37 | 
 38 | 
 39 | def bytes_to_b64(content) -> str:
 40 |     return b64encode(content.encode('utf-8')).decode('ascii')
 41 | 
 42 | 
 43 | class APIObject:
 44 |     """Top level class for objects created from the API"""
 45 | 
 46 |     __slots__: Tuple[str, ...] = ('_response', '_http')
 47 | 
 48 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
 49 |         self._http = _http
 50 |         self._response = response
 51 | 
 52 |     def __repr__(self) -> str:
 53 |         return f'<{self.__class__.__name__}>'
 54 | 
 55 | 
 56 | # === User stuff ===#
 57 | 
 58 | 
 59 | class _BaseUser(APIObject):
 60 |     __slots__ = (
 61 |         'login',
 62 |         'id',
 63 |     )
 64 | 
 65 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
 66 |         super().__init__(response, _http)
 67 |         self._http = _http
 68 |         self.login = response.get('login')
 69 |         self.id = response.get('id')
 70 | 
 71 |     def __repr__(self) -> str:
 72 |         return f'<{self.__class__.__name__} id = {self.id}, login = {self.login!r}>'
 73 | 
 74 |     async def repos(self) -> List[Repository]:
 75 |         """List[:class:`Repository`]: Returns a list of public repositories under the user."""
 76 |         results = await self._http.get_user_repos(self)  # type: ignore
 77 |         return [Repository(data, self._http) for data in results]
 78 | 
 79 |     async def gists(self) -> List[Gist]:
 80 |         """List[:class:`Gist`]: Returns a list of public gists under the user."""
 81 |         results = await self._http.get_user_gists(self)  # type: ignore
 82 |         return [Gist(data, self._http) for data in results]
 83 | 
 84 |     async def orgs(self) -> List[Organization]:
 85 |         """List[:class:`Organization`]: Returns a list of public orgs under the user."""
 86 |         results = await self._http.get_user_orgs(self)  # type: ignore
 87 |         return [Organization(data, self._http) for data in results]
 88 | 
 89 |     @property
 90 |     def name(self):
 91 |         """Optional[str]: The name of the user, if available."""
 92 |         return self._response.get('login')
 93 | 
 94 | 
 95 | class User(_BaseUser):
 96 |     """Representation of a user object on Github.
 97 | 
 98 |     Attributes
 99 |     ----------
100 |     login: :class:`str`
101 |         The API name of the user.
102 |     id: :class:`int`
103 |         The ID of the user.
104 |     avatar_url: :class:`str`
105 |         The url of the user's Github avatar.
106 |     html_url: :class:`str`
107 |         The url of the user's Github page.
108 |     created_at: :class:`datetime.datetime`
109 |         The time of creation of the user.
110 |     """
111 | 
112 |     __slots__ = (
113 |         'login',
114 |         'id',
115 |         'avatar_url',
116 |         'html_url',
117 |         'public_repos',
118 |         'public_gists',
119 |         'followers',
120 |         'following',
121 |         'created_at',
122 |     )
123 | 
124 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
125 |         super().__init__(response, _http)
126 |         tmp = self.__slots__ + _BaseUser.__slots__
127 |         keys = {key: value for key, value in self._response.items() if key in tmp}
128 |         for key, value in keys.items():
129 |             if '_at' in key and value is not None:
130 |                 setattr(self, key, dt_formatter(value))
131 |                 continue
132 |             else:
133 |                 setattr(self, key, value)
134 |                 continue
135 | 
136 |     def __repr__(self) -> str:
137 |         return f'<{self.__class__.__name__} login: {self.login!r}, id: {self.id}, created_at: {self.created_at}>'
138 | 
139 | 
140 | class PartialUser(_BaseUser):
141 |     __slots__ = (
142 |         'site_admin',
143 |         'html_url',
144 |         'avatar_url',
145 |     ) + _BaseUser.__slots__
146 | 
147 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
148 |         super().__init__(response, _http)
149 |         self.site_admin: Optional[str] = response.get('site_admin')
150 |         self.html_url: Optional[str] = response.get('html_url')
151 |         self.avatar_url: Optional[str] = response.get('avatar_url')
152 | 
153 |     def __repr__(self) -> str:
154 |         return f'<{self.__class__.__name__} login: {self.login!r}, id: {self.id}, site_admin: {self.site_admin}'
155 | 
156 |     async def _get_user(self) -> User:
157 |         """Upgrades the PartialUser to a User object."""
158 |         response = await self._http.get_user(self.login)
159 |         return User(response, self._http)
160 | 
161 | 
162 | # === Repository stuff ===#
163 | 
164 | 
165 | class Repository(APIObject):
166 |     """Representation of a repository on Github.
167 | 
168 |     Attributes
169 |     ----------
170 |     id: :class:`int`
171 |         The ID of the repository in the API.
172 |     name: :class:`str`
173 |         The name of the repository in the API.
174 |     owner: :class:`User`
175 |         The owner of the repository.
176 |     created_at: :class:`datetime.datetime`
177 |         The time the repository was created at.
178 |     updated_at: :class:`datetime.datetime`
179 |         The time the repository was last updated.
180 |     url: :class:`str`
181 |         The API url for the repository.
182 |     html_url: :class:`str`
183 |         The human-url of the repository.
184 |     archived: :class:`bool`
185 |         Whether the repository is archived or live.
186 |     open_issues_count: :class:`int`
187 |         The number of the open issues on the repository.
188 |     default_branch: :class:`str`
189 |         The name of the default branch of the repository.
190 |     """
191 | 
192 |     if TYPE_CHECKING:
193 |         id: int
194 |         name: str
195 |         owner: str
196 | 
197 |     __slots__ = (
198 |         'id',
199 |         'name',
200 |         'owner',
201 |         'sizecreated_at',
202 |         'url',
203 |         'html_url',
204 |         'archived',
205 |         'disabled',
206 |         'updated_at',
207 |         'open_issues_count',
208 |         'clone_url',
209 |         'stargazers_count',
210 |         'watchers_count',
211 |         'license',
212 |     )
213 | 
214 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
215 |         super().__init__(response, _http)
216 |         tmp = self.__slots__ + APIObject.__slots__
217 |         keys = {key: value for key, value in self._response.items() if key in tmp}
218 |         for key, value in keys.items():
219 |             if key == 'owner':
220 |                 setattr(self, key, PartialUser(value, self._http))
221 |                 continue
222 | 
223 |             if key == 'name':
224 |                 setattr(self, key, value)
225 |                 continue
226 | 
227 |             if '_at' in key and value is not None:
228 |                 setattr(self, key, dt_formatter(value))
229 |                 continue
230 | 
231 |             if 'license' in key:
232 |                 if value is not None:
233 |                     setattr(self, key, value.get('name'))
234 |                     continue
235 |                 setattr(self, key, None)
236 | 
237 |             else:
238 |                 setattr(self, key, value)
239 |                 continue
240 | 
241 |     def __repr__(self) -> str:
242 |         return f'<{self.__class__.__name__} id: {self.id}, name: {self.name!r}, owner: {self.owner!r}>'
243 | 
244 |     @property
245 |     def is_fork(self) -> bool:
246 |         """:class:`bool`: Whether the repository is a fork."""
247 |         return self._response.get('fork')
248 | 
249 |     @property
250 |     def language(self) -> str:
251 |         """:class:`str`: Primary language of the repository."""
252 |         return self._response.get('language')
253 | 
254 |     @property
255 |     def open_issues(self) -> int:
256 |         """:class:`int`: The number of open issues on the repository."""
257 |         return self._response.get('open_issues')
258 | 
259 |     @property
260 |     def forks(self) -> int:
261 |         """:class:`int`: The number of forks of the repository."""
262 |         return self._response.get('forks')
263 | 
264 |     @property
265 |     def default_branch(self) -> str:
266 |         """:class:`str`: The default branch of the repository."""
267 |         return self._response.get('default_branch')
268 | 
269 |     async def delete(self) -> None:
270 |         """Deletes the repository."""
271 |         return await self._http.delete_repo(
272 |             self.owner.name,  # type: ignore this shit is not my fault
273 |             self.name,
274 |         )  # type: ignore
275 | 
276 |     async def add_file(self, filename: str, message: str, content: str, branch: Optional[str] = None) -> None:
277 |         """Adds a file to the repository.
278 | 
279 |         Parameters
280 |         ----------
281 |         filename: :class:`str` The name of the file.
282 |         message: :class:`str` The commit message.
283 |         content: :class:`str` The content of the file.
284 |         branch: :class:`str` The branch to add the file to, defaults to the default branch.
285 |         """
286 | 
287 |         if branch is None:
288 |             branch = self.default_branch
289 | 
290 |         return await self._http.add_file(owner=self.owner.name, repo_name=self.name, filename=filename, content=content, message=message, branch=branch)  # type: ignore
291 | 
292 | 
293 | class Issue(APIObject):
294 |     """Representation of an issue on Github.
295 | 
296 |     Attributes
297 |     ----------
298 |     id: :class:`int`
299 |         The ID of the issue in the API.
300 |     title: :class:`str`
301 |         The title of the issue in the API.
302 |     user: :class:`User`
303 |         The user who opened the issue.
304 |     labels: List[:class:`str`]
305 |         TODO: document this.
306 |     state: :class:`str`
307 |         The current state of the issue.
308 |     created_at: :class:`datetime.datetime`
309 |         The time the issue was created.
310 |     closed_by: Optional[Union[:class:`PartialUser`, :class:`User`]]
311 |         The user the issue was closed by, if applicable.
312 |     """
313 | 
314 |     __slots__ = (
315 |         'id',
316 |         'title',
317 |         'user',
318 |         'labels',
319 |         'state',
320 |         'created_at',
321 |         'closed_by',
322 |     )
323 | 
324 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
325 |         super().__init__(response, _http)
326 |         tmp = self.__slots__ + APIObject.__slots__
327 |         keys = {key: value for key, value in self._response.items() if key in tmp}
328 |         for key, value in keys.items():
329 |             if key == 'user':
330 |                 setattr(self, key, PartialUser(value, self._http))
331 |                 continue
332 | 
333 |             if key == 'labels':
334 |                 setattr(self, key, [label['name'] for label in value])
335 |                 continue
336 | 
337 |             if key == 'closed_by':
338 |                 setattr(self, key, User(value, self._http))
339 |                 continue
340 | 
341 |             else:
342 |                 setattr(self, key, value)
343 |                 continue
344 | 
345 |     def __repr__(self) -> str:
346 |         return (
347 |             f'<{self.__class__.__name__} id: {self.id}, title: {self.title}, user: {self.user}, created_at:'
348 |             f' {self.created_at}, state: {self.state}>'
349 |         )
350 | 
351 |     @property
352 |     def updated_at(self) -> Optional[datetime]:
353 |         """Optional[:class:`datetime.datetime`]: The time the issue was last updated, if applicable."""
354 |         return dt_formatter(self._response.get('updated_at'))
355 | 
356 |     @property
357 |     def html_url(self) -> str:
358 |         """:class:`str`: The human-friendly url of the issue."""
359 |         return self._response.get('html_url')
360 | 
361 | 
362 | # === Gist stuff ===#
363 | 
364 | 
365 | class File:
366 |     """A wrapper around files and in-memory file-like objects.
367 | 
368 |     Parameters
369 |     ----------
370 |     fp: Union[:class:`str`, :class:`io.StringIO`, :class:`io.BytesIO`]
371 |         The filepath or StringIO representing a file to upload.
372 |         If providing a StringIO instance, a filename shuold also be provided to the file.
373 |     filename: :class:`str`
374 |         An override to the file's name, encouraged to provide this if using a StringIO instance.
375 |     """
376 | 
377 |     def __init__(self, fp: Union[str, io.StringIO, io.BytesIO], filename: str = 'DefaultFilename.txt') -> None:
378 |         self.fp = fp
379 |         self.filename = filename
380 | 
381 |     def read(self) -> str:
382 |         if isinstance(self.fp, str):
383 |             if os.path.exists(self.fp):
384 |                 with open(self.fp) as fp:
385 |                     data = fp.read()
386 |                 return data
387 |             return self.fp
388 |         elif isinstance(self.fp, io.BytesIO):
389 |             return self.fp.read().decode('utf-8')
390 |         elif isinstance(self.fp, io.StringIO):  # type: ignore
391 |             return self.fp.getvalue()
392 | 
393 |         raise TypeError(f'Expected str, io.StringIO, or io.BytesIO, got {type(self.fp)}')
394 | 
395 | 
396 | class Gist(APIObject):
397 |     """Representation of a gist on Github.
398 | 
399 |     Attributes
400 |     ----------
401 |     id: :class:`int`
402 |         The ID of the gist in the API.
403 |     html_url: :class:`str`
404 |         The human-friendly url of the gist.
405 |     files: List[:class:`File`]
406 |         A list of the files in the gist, can be an empty list.
407 |     public: :class:`bool`
408 |         Whether the gist is public.
409 |     owner: Union[:class:`PartialUser`, :class:`User`]
410 |         The owner of the gist.
411 |     created_at: :class:`datetime.datetime`
412 |         The time the gist was created at.
413 |     """
414 | 
415 |     __slots__ = (
416 |         'id',
417 |         'html_url',
418 |         'node_id',
419 |         'files',
420 |         'public',
421 |         'owner',
422 |         'created_at',
423 |         'truncated',
424 |     )
425 | 
426 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
427 |         super().__init__(response, _http)
428 |         tmp = self.__slots__ + APIObject.__slots__
429 |         keys = {key: value for key, value in self._response.items() if key in tmp}
430 |         for key, value in keys.items():
431 |             if key == 'owner':
432 |                 setattr(self, key, PartialUser(value, self._http))
433 |                 continue
434 |             if key == 'created_at':
435 |                 setattr(self, key, dt_formatter(value))
436 |                 continue
437 |             else:
438 |                 setattr(self, key, value)
439 | 
440 |     def __repr__(self) -> str:
441 |         return f'<{self.__class__.__name__} id: {self.id}, owner: {self.owner}, created_at: {self.created_at}>'
442 | 
443 |     @property
444 |     def updated_at(self) -> Optional[datetime]:
445 |         """Optional[:class:`datetime.datetime`]: The time the gist was last updated, if applicable."""
446 |         return dt_formatter(self._response.get('updated_at'))
447 | 
448 |     @property
449 |     def comments(self) -> str:
450 |         """TODO: document this."""
451 |         return self._response.get('comments')
452 | 
453 |     @property
454 |     def discussion(self) -> str:
455 |         """TODO: document this."""
456 |         return self._response.get('discussion')
457 | 
458 |     @property
459 |     def raw(self) -> Dict[str, Any]:
460 |         """TODO: document this."""
461 |         return self._response
462 | 
463 |     @property
464 |     def url(self) -> str:
465 |         return self._response.get('html_url')
466 | 
467 |     async def delete(self):
468 |         """Delete the gist."""
469 |         await self._http.delete_gist(self.id)
470 | 
471 | 
472 | # === Organization stuff ===#
473 | 
474 | 
475 | class Organization(APIObject):
476 |     """Representation of an organization in the API.
477 | 
478 |     Attributes
479 |     ----------
480 |     login: :class:`str`
481 |         TODO: document this
482 |     id: :class:`int`
483 |         The ID of the organization in the API.
484 |     is_verified: :class:`bool`
485 |         Whether or not the organization is verified.
486 |     created_at: :class:`datetime.datetime`
487 |         The time the organization was created at.
488 |     avatar_url: :class:`str`
489 |         The url of the organization's avatar.
490 |     """
491 | 
492 |     __slots__ = (
493 |         'login',
494 |         'id',
495 |         'is_verified',
496 |         'public_repos',
497 |         'public_gists',
498 |         'followers',
499 |         'following',
500 |         'created_at',
501 |         'avatar_url',
502 |     )
503 | 
504 |     def __init__(self, response: Dict[str, Any], _http: http) -> None:
505 |         super().__init__(response, _http)
506 |         tmp = self.__slots__ + APIObject.__slots__
507 |         keys = {key: value for key, value in self._response.items() if key in tmp}
508 |         for key, value in keys.items():
509 |             if key == 'login':
510 |                 setattr(self, key, value)
511 |                 continue
512 |             if '_at' in key and value is not None:
513 |                 setattr(self, key, dt_formatter(value))
514 |                 continue
515 | 
516 |             else:
517 |                 setattr(self, key, value)
518 |                 continue
519 | 
520 |     def __repr__(self):
521 |         return (
522 |             f'<{self.__class__.__name__} login: {self.login!r}, id: {self.id}, is_verified: {self.is_verified},'
523 |             f' public_repos: {self.public_repos}, public_gists: {self.public_gists}, created_at: {self.created_at}>'
524 |         )
525 | 
526 |     @property
527 |     def description(self):
528 |         """:class:`str`: The description of the organization."""
529 |         return self._response.get('description')
530 | 
531 |     @property
532 |     def html_url(self):
533 |         """:class:`str`: The human-friendly url of the organization."""
534 |         return self._response.get('html_url')
535 | 


--------------------------------------------------------------------------------
/github/urls.py:
--------------------------------------------------------------------------------
 1 | # == urls.py ==#
 2 | 
 3 | BASE_URL = 'https://api.github.com'
 4 | 
 5 | 
 6 | # == user urls ==#
 7 | USERS_URL = f"{BASE_URL}/users/{{0}}"
 8 | 
 9 | USER_HTML_URL = 'https://github.com/users/{0}'
10 | 
11 | SELF_URL = f"{BASE_URL}/user"
12 | 
13 | USER_REPOS_URL = f"{USERS_URL}/repos"
14 | 
15 | USER_ORGS_URL = f"{USERS_URL}/orgs"
16 | 
17 | USER_GISTS_URL = f"{USERS_URL}/gists"
18 | 
19 | USER_FOLLOWERS_URL = f"{USERS_URL}/followers"
20 | 
21 | USER_FOLLOWING_URL = f"{USERS_URL}/following"
22 | 
23 | 
24 | # == repo urls ==#
25 | CREATE_REPO_URL = f"{BASE_URL}/user/repos"  # _auth repo create
26 | 
27 | REPOS_URL = f"{BASE_URL}/repos/{{0}}"  # repos of a user
28 | 
29 | REPO_URL = f"{BASE_URL}/repos/{{0}}/{{1}}"  # a specific repo
30 | 
31 | ADD_FILE_URL = f"{BASE_URL}/repos/{{}}/{{}}/contents/{{}}"
32 | 
33 | ADD_FILE_BRANCH = f"{BASE_URL}"
34 | 
35 | REPO_ISSUE_URL = f"{REPO_URL}/issues/{{2}}"  # a specific issue
36 | 
37 | # == gist urls ==#
38 | GIST_URL = f"{BASE_URL}/gists/{{0}}"  # specific gist
39 | 
40 | CREATE_GIST_URL = f"{BASE_URL}/gists"  # create a gist
41 | 
42 | # == org urls ==#
43 | ORG_URL = f"{BASE_URL}/orgs/{{0}}"
44 | 


--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
 1 | [tool.black]
 2 | line-length = 125
 3 | skip-string-normalization = true
 4 | preview = true  # better formatting basically
 5 | 
 6 | [tool.isort]
 7 | line_length = 125
 8 | combine_as_imports = true
 9 | combine_star = true
10 | 
11 | [tool.pyright]
12 | typeCheckingMode = "basic"
13 | strictListInference = true
14 | strictDictionaryInference = true
15 | strictSetInference = true
16 | 
17 | # explicity enabling is better than making it strict and disabling stuff
18 | reportMissingModuleSource = "error"
19 | reportAssertAlwaysTrue = "error"
20 | reportInvalidStringEscapeSequence = "error"
21 | reportInvalidTypeVarUse = "error"
22 | reportSelfClsParameterName = "error"
23 | reportUnsupportedDunderAll = "error"
24 | reportUnusedExpression = "error"
25 | reportWildcardImportFromLibrary = "error"
26 | reportConstantRedefinition = "error"
27 | reportDuplicateImport = "error"
28 | reportImportCycles = "error"
29 | reportIncompatibleVariableOverride = "error"
30 | reportIncompleteStub = "error"
31 | reportInconsistentConstructor = "error"
32 | reportInvalidStubStatement = "error"
33 | reportMatchNotExhaustive = "error"
34 | reportMissingParameterType = "error"
35 | reportTypeCommentUsage = "error"
36 | reportUnnecessaryCast = "error"
37 | reportUnnecessaryComparison = "error"
38 | reportUnnecessaryIsInstance = "error"
39 | reportUnusedClass = "error"
40 | reportUnusedVariable = "error"
41 | reportUntypedBaseClass = "error"
42 | reportUntypedClassDecorator = "error"
43 | reportUntypedFunctionDecorator = "error"
44 | reportUntypedNamedTuple = "error"
45 | reportCallInDefaultInitializer = "error"
46 | reportPropertyTypeMismatch = "error"
47 | reportUnnecessaryTypeIgnoreComment = "error"
48 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | aiohttp>=3.8.1
2 | typing-extensions
3 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
 1 | [metadata]
 2 | name = github
 3 | version = 1.2.7
 4 | description = An asynchronous python wrapper around the GitHub API
 5 | long_description = file: README.md
 6 | long_description_content_type = text/markdown
 7 | url = https://github.com/VarMonke/Github-Api-Wrapper
 8 | author = VarMonke and sudosnok
 9 | author_email = var.monke@gmail.com
10 | license = MIT
11 | license_file = LICENSE
12 | platform = any
13 | project_urls =
14 |     Issue Tracker = https://github.com/VarMonke/Github-Api-Wrapper/issues
15 | 
16 | [options]
17 | packages = find:
18 | python_requires = >=3.8
19 | install_requires =
20 |     aiohttp >= 3.8.1
21 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | import re
 2 | from pathlib import Path
 3 | 
 4 | from setuptools import setup
 5 | 
 6 | packages = [
 7 |     'github',
 8 | ]
 9 | 
10 | extras_require = {
11 |     'docs': [
12 |         'sphinx==4.4.0',
13 |         'sphinxcontrib_trio==1.1.2',
14 |         'sphinxcontrib-websupport',
15 |         'typing-extensions',
16 |     ],
17 | }
18 | 
19 | setup(
20 |     name='github',
21 |     author='VarMonke & sudosnok',
22 |     url='https://github.com/VarMonke/Github-Api-Wrapper',
23 |     version=re.search(r'\d[.]\d[.]\d', (Path('github') / '__init__.py').read_text())[0],
24 |     packages=packages,
25 |     license='MIT',
26 |     description='An asynchronous python wrapper around the GitHub API',
27 |     long_description=Path('README.rst').read_text(),
28 |     install_requires=Path('requirements.txt').read_text().splitlines(),
29 |     python_requires='>=3.8.0',
30 | )
31 | 


--------------------------------------------------------------------------------