├── .gitattributes
├── .gitignore
├── .readthedocs.yml
├── LICENSE
├── README.md
├── docs
    ├── Makefile
    ├── _static
    │   ├── custom.js
    │   ├── settings.js
    │   └── style.css
    ├── _templates
    │   ├── base.html
    │   ├── page.html
    │   └── search.html
    ├── api.rst
    ├── changelog.rst
    ├── conf.py
    ├── ext
    │   └── commands
    │   │   ├── api.rst
    │   │   ├── cogs.rst
    │   │   ├── commands.rst
    │   │   ├── extensions.rst
    │   │   └── index.rst
    ├── faq.rst
    ├── help.rst
    ├── index.rst
    ├── intro.rst
    ├── localexts
    │   ├── attributetable.py
    │   └── viewcode.py
    ├── make.bat
    ├── requirements.txt
    ├── resources
    │   └── images
    │   │   └── authorization_code.png
    └── usedby.rst
├── examples
    ├── basic_bot.py
    ├── discord_integration.py
    ├── fortnite_api_path.py
    ├── multiple_clients.py
    ├── sanic_integration.py
    └── subclass_client.py
├── rebootpy
    ├── __init__.py
    ├── auth.py
    ├── avatar.py
    ├── client.py
    ├── creative.py
    ├── enums.py
    ├── errors.py
    ├── ext
    │   └── commands
    │   │   ├── __init__.py
    │   │   ├── _types.py
    │   │   ├── bot.py
    │   │   ├── cog.py
    │   │   ├── context.py
    │   │   ├── converter.py
    │   │   ├── cooldown.py
    │   │   ├── core.py
    │   │   ├── errors.py
    │   │   ├── help.py
    │   │   ├── typedefs.py
    │   │   └── view.py
    ├── friend.py
    ├── http.py
    ├── message.py
    ├── news.py
    ├── party.py
    ├── playlist.py
    ├── presence.py
    ├── stats.py
    ├── store.py
    ├── typedefs.py
    ├── user.py
    ├── utils.py
    ├── websocket.py
    └── xmpp.py
├── requirements.txt
└── setup.py


/.gitattributes:
--------------------------------------------------------------------------------
1 | # Auto detect text files and perform LF normalization
2 | * text=auto
3 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | # Byte-compiled / optimized / DLL files
  2 | __pycache__/
  3 | *.py[cod]
  4 | *$py.class
  5 | 
  6 | # C extensions
  7 | *.so
  8 | 
  9 | # Distribution / packaging
 10 | .Python
 11 | build/
 12 | develop-eggs/
 13 | dist/
 14 | downloads/
 15 | eggs/
 16 | .eggs/
 17 | lib/
 18 | lib64/
 19 | parts/
 20 | sdist/
 21 | var/
 22 | wheels/
 23 | *.egg-info/
 24 | .installed.cfg
 25 | *.egg
 26 | MANIFEST
 27 | 
 28 | # PyInstaller
 29 | #  Usually these files are written by a python script from a template
 30 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 31 | *.manifest
 32 | *.spec
 33 | 
 34 | # Installer logs
 35 | pip-log.txt
 36 | pip-delete-this-directory.txt
 37 | 
 38 | # Unit test / coverage reports
 39 | htmlcov/
 40 | .tox/
 41 | .coverage
 42 | .coverage.*
 43 | .cache
 44 | nosetests.xml
 45 | coverage.xml
 46 | *.cover
 47 | .hypothesis/
 48 | .pytest_cache/
 49 | 
 50 | # Translations
 51 | *.mo
 52 | *.pot
 53 | 
 54 | # Django stuff:
 55 | *.log
 56 | local_settings.py
 57 | db.sqlite3
 58 | 
 59 | # Flask stuff:
 60 | instance/
 61 | .webassets-cache
 62 | 
 63 | # Scrapy stuff:
 64 | .scrapy
 65 | 
 66 | # Sphinx documentation
 67 | docs/_build/
 68 | 
 69 | # PyBuilder
 70 | target/
 71 | 
 72 | # Jupyter Notebook
 73 | .ipynb_checkpoints
 74 | 
 75 | # pyenv
 76 | .python-version
 77 | 
 78 | # celery beat schedule file
 79 | celerybeat-schedule
 80 | 
 81 | # SageMath parsed files
 82 | *.sage.py
 83 | 
 84 | # Environments
 85 | .env
 86 | .venv
 87 | env/
 88 | venv/
 89 | ENV/
 90 | env.bak/
 91 | venv.bak/
 92 | .idea/
 93 | 
 94 | # Spyder project settings
 95 | .spyderproject
 96 | .spyproject
 97 | 
 98 | # Rope project settings
 99 | .ropeproject
100 | 
101 | # mkdocs documentation
102 | /site
103 | 
104 | # mypy
105 | .mypy_cache/
106 | 
107 | .vscode
108 | tests/
109 | exttest/
110 | test*
111 | __ignore*
112 | voice.py
113 | output.txt
114 | todo.txt
115 | 
116 | examples/api_integrations/terax_api.py
117 | device_auths.json
118 | config.json
119 | 
120 | .DS_Store


--------------------------------------------------------------------------------
/.readthedocs.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | 
 3 | build:
 4 |   os: ubuntu-22.04
 5 |   tools:
 6 |     python: "3.7"
 7 | 
 8 | sphinx:
 9 |   configuration: docs/conf.py
10 | 
11 | python:
12 |   install:
13 |     - requirements: docs/requirements.txt


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019-2020 Terbau
 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 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 |  # rebootpy
 2 | 
 3 | [![Supported py versions](https://img.shields.io/pypi/pyversions/rebootpy.svg)](https://pypi.org/project/rebootpy/)
 4 | [![Current pypi version](https://img.shields.io/pypi/v/rebootpy.svg)](https://pypi.org/project/rebootpy/)
 5 | [![Donate link](https://img.shields.io/badge/paypal-donate_to_terbau-blue)](https://www.paypal.me/terbau)
 6 | 
 7 | Asynchronous library for interacting with Fortnite and EpicGames' API and XMPP services.
 8 | 
 9 | This library is a fork of [Terbau](https://github.com/Terbau/)'s [fortnitepy](https://github.com/Terbau/fortnitepy) which was abandoned.<br>
10 | If you want to check out the original commit history, you can view it [here](https://github.com/Terbau/fortnitepy/commits/master/).
11 | 
12 | **Note:** This library is still under development so breaking changes might happen at any time.
13 | 
14 | **Some key features:**
15 | - Full support for Friends.
16 | - Support for XMPP events.
17 | - Support for Parties.
18 | - Support for Battle Royale stats.
19 | - ~~Support for friend & party messages.~~ (currently broken on all libraries due to signing algorithm not being reversed yet)
20 | 
21 | # Documentation
22 | https://rebootpy.readthedocs.io/en/latest/
23 | 
24 | # Installing
25 | ```
26 | # windows
27 | py -3 -m pip install -U rebootpy
28 | 
29 | # linux
30 | python3 -m pip install -U rebootpy
31 | ```
32 | 
33 | # Basic usage
34 | ```py
35 | import rebootpy
36 | 
37 | from rebootpy.ext import commands
38 | 
39 | bot = commands.Bot(
40 |     command_prefix='!',
41 |     auth=rebootpy.AuthorizationCodeAuth()
42 | )
43 | 
44 | @bot.event
45 | async def event_ready():
46 |     print(f'Bot ready as {bot.user.display_name} ({bot.user.id})')
47 | 
48 | @bot.event
49 | async def event_friend_request(request):
50 |     await request.accept()
51 | 
52 | @bot.command()
53 | async def hello(ctx):
54 |     await ctx.send('Hello!')
55 | 
56 | bot.run()
57 | ```
58 | 
59 | # Authorization Code
60 | How to get a one time authorization code:
61 | 1. Log into the epic games account of your choice [here](https://www.epicgames.com/id/login?redirectUrl=https%3A%2F%2Fwww.epicgames.com%2Fid%2Fapi%2Fredirect%3FclientId%3D3f69e56c7649492c8cc29f1af08a8a12%26responseType%3Dcode).
62 | 2. Copy the value of the `authorizationCode` field from the response as shown in the image below:
63 | 
64 | ![Authorization Code](https://raw.githubusercontent.com/xMistt/rebootpy/main/docs/resources/images/authorization_code.png)
65 | 
66 | Keep in mind that authorization code isn't the only method of authentication, you can view all of them [here](https://rebootpy.readthedocs.io/en/latest/api.html#authentication), DeviceAuth is recommended once you've generated device auths.
67 | 
68 | # Credit
69 | Thanks to [Kysune](https://github.com/SzymonLisowiec), [iXyles](https://github.com/iXyles), [Vrekt](https://github.com/Vrekt), [amrsatrio](https://github.com/Amrsatrio) and [This Nils](https://github.com/thisnils) for ideas and/or work that this library is built upon.
70 | 
71 | # Need help?
72 | If you need more help feel free to join this [discord server](https://discord.gg/rnk869s).
73 | 


--------------------------------------------------------------------------------
/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."


--------------------------------------------------------------------------------
/docs/_static/custom.js:
--------------------------------------------------------------------------------
 1 | function setTheme(themeToSet) {
 2 |   localStorage.setItem('theme', themeToSet);
 3 |   document.documentElement.setAttribute("data-theme", themeToSet);
 4 | }
 5 | 
 6 | function getCurrentTheme() {
 7 |   return document.documentElement.getAttribute("data-theme");
 8 | }
 9 | 
10 | $(document).ready(function () {
11 |   var sections = $('div.section');
12 |   var activeLink = null;
13 |   var bottomHeightThreshold = $(document).height() - 30;
14 | 
15 |   $(window).scroll(function () {
16 |     var distanceFromTop = $(this).scrollTop();
17 |     var currentSection = null;
18 | 
19 |     if (distanceFromTop + window.innerHeight > bottomHeightThreshold) {
20 |       currentSection = $(sections[sections.length - 1]);
21 |     }
22 |     else {
23 |       sections.each(function () {
24 |         var section = $(this);
25 |         if (section.offset().top - 1 < distanceFromTop) {
26 |           currentSection = section;
27 |         }
28 |       });
29 |     }
30 | 
31 |     if (activeLink) {
32 |       activeLink.parent().removeClass('active');
33 |     }
34 | 
35 |     if (currentSection) {
36 |       activeLink = $('.sphinxsidebar a[href="#' + currentSection.attr('id') + '"]');
37 |       activeLink.parent().addClass('active');
38 |     }
39 |   });
40 | 
41 |   // Store the fullname of the element clicked for possibly later use.
42 |   $('.source-link').parent().click(function () {
43 |     const rawFullname = $(this).children(":first").attr('class').split(/\s+/).find(function (c) {
44 |       return c.startsWith('fullname')
45 |     });
46 |     if (!rawFullname) return;
47 | 
48 |     const split = rawFullname.split('-');
49 |     let fullname = split.slice(1, split.length).join('.');
50 | 
51 |     if (fullname === 'none') fullname = null;
52 |     sessionStorage.setItem('referrer', fullname);
53 |   });
54 | 
55 |   // Check if a referrer is stored and if so use that value.
56 |   $('.docs-link').click(function () {
57 |     const fullname = sessionStorage.getItem('referrer');
58 |     if (!fullname || fullname === 'null') return;
59 | 
60 |     const elem = $(this);
61 |     const newHref = elem.attr('href').split('#').slice(0, 1) + '#' + fullname;
62 |     elem.attr('href', newHref);
63 |   });
64 | });
65 | 
66 | $(document).on('DOMContentLoaded', function () {
67 |   const tables = document.querySelectorAll('.py-attribute-table[data-move-to-id]');
68 |   tables.forEach(function (table) {
69 |     let element = document.getElementById(table.getAttribute('data-move-to-id'));
70 |     let parent = element.parentNode;
71 |     // insert ourselves after the element
72 |     parent.insertBefore(table, element.nextSibling);
73 |   });
74 | });
75 | 


--------------------------------------------------------------------------------
/docs/_static/settings.js:
--------------------------------------------------------------------------------
 1 | $(document).ready(function(){
 2 |     var settingsBackgroundElement = $("#settings-background");
 3 |     var settingsContainerElement = $("#settings-container");
 4 |     var settingsButtonElement = $("#settings-button");
 5 |     var settingsCloseButtonElement = $("#settings-close-button");
 6 | 
 7 |     var radioThemeLight = $("#radio-theme-light");
 8 |     var radioThemeDark = $("#radio-theme-dark");
 9 |     var radioLabelThemeLight = $("#radio-label-theme-light");
10 |     var radioLabelThemeDark = $("#radio-label-theme-dark");
11 | 
12 |     function isVisible() {
13 |         return settingsBackgroundElement.css("display") === "flex";
14 |     }
15 | 
16 |     function toggleSettings(visible) {
17 |         if (visible === undefined) visible = !isVisible();
18 |         settingsBackgroundElement.css("display", visible ? "flex" : "none");
19 |     }
20 | 
21 |     settingsButtonElement.click(function() {
22 |         toggleSettings();
23 |     });
24 | 
25 |     settingsBackgroundElement.click(function() {
26 |         toggleSettings();
27 |     });
28 | 
29 |     settingsContainerElement.click(function(e) {
30 |         e.stopPropagation()
31 |     });
32 | 
33 |     settingsCloseButtonElement.click(function() {
34 |         toggleSettings();
35 |     });
36 | 
37 |     // Actual settings below
38 | 
39 |     radioLabelThemeLight.click(function() {
40 |         setTheme("light");
41 |     });
42 | 
43 |     radioLabelThemeDark.click(function() {
44 |         setTheme("dark");
45 |     });
46 | 
47 |     let elemToCheck = getCurrentTheme() === "light" ? radioThemeLight : radioThemeDark;
48 |     elemToCheck.attr("checked", "checked");
49 | });


--------------------------------------------------------------------------------
/docs/_templates/base.html:
--------------------------------------------------------------------------------
  1 | <!doctype html>
  2 | <html class="no-js">
  3 | 
  4 | <head>
  5 |     {%- block site_meta -%}
  6 |     <meta charset="utf-8" />
  7 |     <meta name="viewport" content="width=device-width,initial-scale=1" />
  8 |     <meta name="color-scheme" content="light dark">
  9 | 
 10 |     {%- if metatags %}{{ metatags }}{% endif -%}
 11 | 
 12 |     {%- block linktags %}
 13 |     {%- if hasdoc('about') -%}
 14 |     <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
 15 |     {%- endif -%}
 16 |     {%- if hasdoc('genindex') -%}
 17 |     <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
 18 |     {%- endif -%}
 19 |     {%- if hasdoc('search') -%}
 20 |     <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
 21 |     {%- endif -%}
 22 |     {%- if hasdoc('copyright') -%}
 23 |     <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
 24 |     {%- endif -%}
 25 |     {%- if next -%}
 26 |     <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
 27 |     {%- endif -%}
 28 |     {%- if prev -%}
 29 |     <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
 30 |     {%- endif -%}
 31 |     {%- endblock linktags %}
 32 | 
 33 |     {# Favicon #}
 34 |     {%- if favicon -%}
 35 |     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}" />
 36 |     {%- endif -%}
 37 | 
 38 |     {#- Generator banner -#}
 39 |     <meta name="generator" content="sphinx-{{ sphinx_version }}, furo {{ furo_version }}" />
 40 | 
 41 |     {%- endblock site_meta -%}
 42 | 
 43 |     {#- Site title -#}
 44 |     {%- block htmltitle -%}
 45 |     {% if pagename == master_doc %}
 46 |     <title>{{ _("Home") }} - {{ docstitle|striptags|e }}</title>
 47 |     {% else %}
 48 |     <title>{{ title|striptags|e }} - {{ docstitle|striptags|e }}</title>
 49 |     {% endif %}
 50 |     {%- endblock -%}
 51 | 
 52 |     <script>
 53 |         var theme = localStorage.getItem('theme');
 54 |         if (theme === null) {
 55 |             if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) theme = 'dark';
 56 |             else theme = 'light';
 57 |         }
 58 |         document.documentElement.setAttribute("data-theme", theme);
 59 |     </script>
 60 | 
 61 |     {%- block scripts -%}
 62 | 
 63 |     {# Custom JS #}
 64 |     {%- block regular_scripts -%}
 65 |     {# This is *exactly* how `basic` handles this file. #}
 66 |     <script id="documentation_options" data-url_root="{{ pathto('', 1) }}"
 67 |         src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
 68 |     {% for path in script_files -%}
 69 |     {{ js_tag(path) }}
 70 |     {% endfor -%}
 71 |     {%- endblock regular_scripts -%}
 72 | 
 73 |     {# Theme-related JavaScript code #}
 74 |     {%- block theme_scripts -%}
 75 |     <script src="{{ pathto(furo_assets['main.js'], 1) }}"></script>
 76 |     {%- endblock -%}
 77 | 
 78 |     {%- endblock scripts -%}
 79 | 
 80 |     {%- block styles -%}
 81 | 
 82 |     {#- Theme-related stylesheets -#}
 83 |     {%- block theme_styles -%}
 84 |     <link rel="stylesheet" href="{{ pathto(furo_assets['style'], 1) }}">
 85 |     <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}">
 86 |     <link media="(prefers-color-scheme: dark)" rel="stylesheet" href="{{ pathto('_static/pygments_dark.css', 1) }}">
 87 |     {% include "partials/_head_css_variables.html" with context %}
 88 |     {%- endblock -%}
 89 | 
 90 |     {# Custom stylesheets #}
 91 |     {%- block regular_styles -%}
 92 |     {%- for path in css_files -%}
 93 |     {% if not path.filename.startswith("pygments_dark") -%}
 94 |     {{ css_tag(path) }}
 95 |     {%- endif %}
 96 |     {% endfor -%}
 97 |     {%- endblock regular_styles -%}
 98 | 
 99 |     {%- block extra_styles -%}
100 |     <link rel="stylesheet" href="{{ pathto(furo_assets['furo-extensions.css'], 1) }}">
101 |     {%- endblock -%}
102 | 
103 |     {%- endblock styles -%}
104 | 
105 |     {#- Custom front matter #}
106 |     {%- block extrahead -%}{%- endblock -%}
107 | </head>
108 | 
109 | <body dir="{{ direction }}">
110 |     {% block body %}{% endblock %}
111 | 
112 |     {%- if READTHEDOCS %}
113 |     <script>
114 |         if (typeof READTHEDOCS_DATA !== "undefined") {
115 |             if (!READTHEDOCS_DATA.features) {
116 |                 READTHEDOCS_DATA.features = {};
117 |             }
118 |             READTHEDOCS_DATA.features.docsearch_disabled = true;
119 |         }
120 |     </script>
121 |     {%- endif %}
122 | </body>
123 | 
124 | </html>


--------------------------------------------------------------------------------
/docs/_templates/page.html:
--------------------------------------------------------------------------------
  1 | {% extends "base.html" %}
  2 | 
  3 | {% block body -%}
  4 | {% include "partials/icons.html" %}
  5 | 
  6 | <div id="settings-background" style="display: none;">
  7 |     <div id="settings-container">
  8 |         <div style="display: inline-block;">
  9 |             <p id="settings-close-button">×</p>
 10 |             <h2>Settings</h2>
 11 |         </div>
 12 |         
 13 |         <div style="height: 80px;">
 14 |             <h3>Theme</h3>
 15 |             <div class="switch-field">
 16 |                 <input type="radio" id="radio-theme-light" name="radio-theme" value="light" />
 17 |                 <label for="radio-theme-light" id="radio-label-theme-light">Light</label>
 18 |                 <input type="radio" id="radio-theme-dark" name="radio-theme" value="dark" />
 19 |                 <label for="radio-theme-dark" id="radio-label-theme-dark">Dark</label>
 20 |             </div>
 21 |         </div>
 22 |     </div>
 23 | </div>
 24 | 
 25 | <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
 26 | <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
 27 | <label class="overlay sidebar-overlay" for="__navigation"></label>
 28 | <label class="overlay toc-overlay" for="__toc"></label>
 29 | 
 30 | {% if theme_announcement -%}
 31 | <div class="announcement">
 32 |     <aside class="announcement-content">
 33 |         {% block announcement %} {{ theme_announcement }} {% endblock announcement %}
 34 |     </aside>
 35 | </div>
 36 | {%- endif %}
 37 | 
 38 | <div class="page">
 39 |     <header class="mobile-header">
 40 |         <div class="header-left">
 41 |             <label class="nav-overlay-icon" for="__navigation">
 42 |                 <i class="icon"><svg>
 43 |                         <use href="#svg-menu"></use>
 44 |                     </svg></i>
 45 |             </label>
 46 |         </div>
 47 |         <div class="header-center">
 48 |             <a href="{{ pathto(master_doc) }}">
 49 |                 <div class="brand">{{ docstitle }}</div>
 50 |             </a>
 51 |         </div>
 52 |         <div class="header-right">
 53 |             <label class="toc-overlay-icon toc-header-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
 54 |                 <i class="icon"><svg>
 55 |                         <use href="#svg-toc"></use>
 56 |                     </svg></i>
 57 |             </label>
 58 |         </div>
 59 |     </header>
 60 |     <aside class="sidebar-drawer">
 61 |         <div class="sidebar-container">
 62 |             {% block left_sidebar %}
 63 |             <div class="sidebar-sticky">
 64 |                 {%- for sidebar_section in sidebars %}
 65 |                 {%- include sidebar_section %}
 66 |                 {%- endfor %}
 67 |             </div>
 68 |             {% endblock left_sidebar %}
 69 |         </div>
 70 |     </aside>
 71 |     <main class="main">
 72 |         <div class="content">
 73 |             <article role="main">
 74 |                 <label class="toc-overlay-icon toc-content-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
 75 |                     <i class="icon"><svg>
 76 |                             <use href="#svg-toc"></use>
 77 |                         </svg></i>
 78 |                 </label>
 79 |                 {% block content %}{{ body }}{% endblock %}
 80 |             </article>
 81 |             <footer>
 82 |                 {% block footer %}
 83 |                 <div class="related-pages">
 84 |                     {% if next -%}
 85 |                     <a class="next-page" href="{{ next.link }}">
 86 |                         <div class="page-info">
 87 |                             <div class="context">
 88 |                                 <span>{{ _("Next") }}</span>
 89 |                             </div>
 90 |                             <div class="title">{{ next.title }}</div>
 91 |                         </div>
 92 |                         <svg>
 93 |                             <use href="#svg-arrow-right"></use>
 94 |                         </svg>
 95 |                     </a>
 96 |                     {%- endif %}
 97 |                     {% if prev -%}
 98 |                     <a class="prev-page" href="{{ prev.link }}">
 99 |                         <svg>
100 |                             <use href="#svg-arrow-right"></use>
101 |                         </svg>
102 |                         <div class="page-info">
103 |                             <div class="context">
104 |                                 <span>{{ _("Previous") }}</span>
105 |                             </div>
106 |                             {% if prev.link == pathto(master_doc) %}
107 |                             <div class="title">{{ _("Home") }}</div>
108 |                             {% else %}
109 |                             <div class="title">{{ prev.title }}</div>
110 |                             {% endif %}
111 |                         </div>
112 |                     </a>
113 |                     {%- endif %}
114 |                 </div>
115 | 
116 |                 <div class="related-information">
117 |                     {%- if show_copyright %}
118 |                     {%- if hasdoc('copyright') %}
119 |                     {% trans path=pathto('copyright'), copyright=copyright|e -%}
120 |                     <a href="{{ path }}">Copyright</a> &#169; {{ copyright }}.
121 |                     {%- endtrans %}
122 |                     {%- else %}
123 |                     {% trans copyright=copyright|e -%}
124 |                     Copyright &#169; {{ copyright }}
125 |                     {%- endtrans %}
126 |                     {%- endif %}
127 |                     {%- endif %}
128 |                     {%- if last_updated %}
129 |                     |
130 |                     {% trans last_updated=last_updated|e -%}
131 |                     Last updated on {{ last_updated }}.
132 |                     {%- endtrans %}
133 |                     {%- endif %}
134 |                     {%- if show_sphinx %}
135 |                     |
136 |                     {% trans -%}
137 |                     Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
138 |                     and
139 |                     <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
140 |                     <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
141 |                     {%- endtrans %}
142 |                     {%- endif %}
143 |                     {%- if show_source and has_source and sourcename %}
144 |                     |
145 |                     <a class="muted-link" href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">
146 |                         {{ _('Show Source') }}
147 |                     </a>
148 |                     {%- endif %}
149 |                 </div>
150 |                 {% endblock footer %}
151 |             </footer>
152 |         </div>
153 |         <aside class="toc-drawer{% if furo_hide_toc %} no-toc{% endif %}">
154 |             {% block right_sidebar %}
155 |             {% if not furo_hide_toc %}
156 |             <div class="toc-sticky toc-scroll">
157 |                 
158 |                 <div class="toc-title-container" id="settings-button-container">
159 |                     <button id="settings-button">
160 |                         <svg class="svg-icon" viewBox="0 0 20 20">
161 |                             <path
162 |                                 d="M17.498,11.697c-0.453-0.453-0.704-1.055-0.704-1.697c0-0.642,0.251-1.244,0.704-1.697c0.069-0.071,0.15-0.141,0.257-0.22c0.127-0.097,0.181-0.262,0.137-0.417c-0.164-0.558-0.388-1.093-0.662-1.597c-0.075-0.141-0.231-0.22-0.391-0.199c-0.13,0.02-0.238,0.027-0.336,0.027c-1.325,0-2.401-1.076-2.401-2.4c0-0.099,0.008-0.207,0.027-0.336c0.021-0.158-0.059-0.316-0.199-0.391c-0.503-0.274-1.039-0.498-1.597-0.662c-0.154-0.044-0.32,0.01-0.416,0.137c-0.079,0.106-0.148,0.188-0.22,0.257C11.244,2.956,10.643,3.207,10,3.207c-0.642,0-1.244-0.25-1.697-0.704c-0.071-0.069-0.141-0.15-0.22-0.257C7.987,2.119,7.821,2.065,7.667,2.109C7.109,2.275,6.571,2.497,6.07,2.771C5.929,2.846,5.85,3.004,5.871,3.162c0.02,0.129,0.027,0.237,0.027,0.336c0,1.325-1.076,2.4-2.401,2.4c-0.098,0-0.206-0.007-0.335-0.027C3.001,5.851,2.845,5.929,2.77,6.07C2.496,6.572,2.274,7.109,2.108,7.667c-0.044,0.154,0.01,0.32,0.137,0.417c0.106,0.079,0.187,0.148,0.256,0.22c0.938,0.936,0.938,2.458,0,3.394c-0.069,0.072-0.15,0.141-0.256,0.221c-0.127,0.096-0.181,0.262-0.137,0.416c0.166,0.557,0.388,1.096,0.662,1.596c0.075,0.143,0.231,0.221,0.392,0.199c0.129-0.02,0.237-0.027,0.335-0.027c1.325,0,2.401,1.076,2.401,2.402c0,0.098-0.007,0.205-0.027,0.334C5.85,16.996,5.929,17.154,6.07,17.23c0.501,0.273,1.04,0.496,1.597,0.66c0.154,0.047,0.32-0.008,0.417-0.137c0.079-0.105,0.148-0.186,0.22-0.256c0.454-0.453,1.055-0.703,1.697-0.703c0.643,0,1.244,0.25,1.697,0.703c0.071,0.07,0.141,0.15,0.22,0.256c0.073,0.098,0.188,0.152,0.307,0.152c0.036,0,0.073-0.004,0.109-0.016c0.558-0.164,1.096-0.387,1.597-0.66c0.141-0.076,0.22-0.234,0.199-0.393c-0.02-0.129-0.027-0.236-0.027-0.334c0-1.326,1.076-2.402,2.401-2.402c0.098,0,0.206,0.008,0.336,0.027c0.159,0.021,0.315-0.057,0.391-0.199c0.274-0.5,0.496-1.039,0.662-1.596c0.044-0.154-0.01-0.32-0.137-0.416C17.648,11.838,17.567,11.77,17.498,11.697 M16.671,13.334c-0.059-0.002-0.114-0.002-0.168-0.002c-1.749,0-3.173,1.422-3.173,3.172c0,0.053,0.002,0.109,0.004,0.166c-0.312,0.158-0.64,0.295-0.976,0.406c-0.039-0.045-0.077-0.086-0.115-0.123c-0.601-0.6-1.396-0.93-2.243-0.93s-1.643,0.33-2.243,0.93c-0.039,0.037-0.077,0.078-0.116,0.123c-0.336-0.111-0.664-0.248-0.976-0.406c0.002-0.057,0.004-0.113,0.004-0.166c0-1.75-1.423-3.172-3.172-3.172c-0.054,0-0.11,0-0.168,0.002c-0.158-0.312-0.293-0.639-0.405-0.975c0.044-0.039,0.085-0.078,0.124-0.115c1.236-1.236,1.236-3.25,0-4.486C3.009,7.719,2.969,7.68,2.924,7.642c0.112-0.336,0.247-0.664,0.405-0.976C3.387,6.668,3.443,6.67,3.497,6.67c1.75,0,3.172-1.423,3.172-3.172c0-0.054-0.002-0.11-0.004-0.168c0.312-0.158,0.64-0.293,0.976-0.405C7.68,2.969,7.719,3.01,7.757,3.048c0.6,0.6,1.396,0.93,2.243,0.93s1.643-0.33,2.243-0.93c0.038-0.039,0.076-0.079,0.115-0.123c0.336,0.112,0.663,0.247,0.976,0.405c-0.002,0.058-0.004,0.114-0.004,0.168c0,1.749,1.424,3.172,3.173,3.172c0.054,0,0.109-0.002,0.168-0.004c0.158,0.312,0.293,0.64,0.405,0.976c-0.045,0.038-0.086,0.077-0.124,0.116c-0.6,0.6-0.93,1.396-0.93,2.242c0,0.847,0.33,1.645,0.93,2.244c0.038,0.037,0.079,0.076,0.124,0.115C16.964,12.695,16.829,13.021,16.671,13.334 M10,5.417c-2.528,0-4.584,2.056-4.584,4.583c0,2.529,2.056,4.584,4.584,4.584s4.584-2.055,4.584-4.584C14.584,7.472,12.528,5.417,10,5.417 M10,13.812c-2.102,0-3.812-1.709-3.812-3.812c0-2.102,1.71-3.812,3.812-3.812c2.102,0,3.812,1.71,3.812,3.812C13.812,12.104,12.102,13.812,10,13.812">
163 |                             </path>
164 |                         </svg>
165 |                     </button>
166 |                 </div>
167 |                 <div class="toc-title-container">
168 |                     <span class="toc-title">
169 |                         {{ _("Contents") }}
170 |                     </span>
171 |                 </div>
172 |                 <div class="toc-tree-container">
173 |                     <div class="toc-tree">
174 |                         {{ toc }}
175 |                     </div>
176 |                 </div>
177 |             </div>
178 |             {% endif %}
179 |             {% endblock right_sidebar %}
180 |         </aside>
181 |     </main>
182 | </div>
183 | {%- endblock %}


--------------------------------------------------------------------------------
/docs/_templates/search.html:
--------------------------------------------------------------------------------
 1 | {% extends "page.html" %}
 2 | 
 3 | {%- block regular_scripts -%}
 4 | {{ super() }}
 5 | <script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
 6 | <script src="{{ pathto('_static/language_data.js', 1) }}"></script>
 7 | {%- endblock regular_scripts-%}
 8 | 
 9 | {%- block htmltitle -%}
10 | <title>{{ _("Search") }} - {{ docstitle }}</title>
11 | {%- endblock htmltitle -%}
12 | 
13 | {% block content %}
14 | <div id="fallback" class="admonition error">
15 |     <p class="admonition-title">{% trans %}Error{% endtrans %}</p>
16 |     <p>
17 |         {% trans %}Please activate JavaScript to enable the search functionality.{% endtrans %}
18 |     </p>
19 | </div>
20 | <script>
21 |     document.getElementById('fallback').hidden = true;
22 | </script>
23 | 
24 | <div id="search-results"></div>
25 | {% endblock %}
26 | 
27 | {% block scripts -%}
28 | {{ super() }}
29 | <script src="{{ pathto('searchindex.js', 1) }}"></script>
30 | {%- endblock scripts %}


--------------------------------------------------------------------------------
/docs/changelog.rst:
--------------------------------------------------------------------------------
  1 | .. currentmodule:: rebootpy
  2 | 
  3 | Changelog
  4 | =========
  5 | 
  6 | Detailed version changes.
  7 | You can also view the changelog of the original library, fortnitepy, `here <https://fortnitepy.readthedocs.io/en/latest/changelog.html>`_.
  8 | 
  9 | v0.9.5 (pre-release)
 10 | ------
 11 | 
 12 | Added
 13 | ~~~~~
 14 | 
 15 | - Added ``RankingType.BALLISTIC``
 16 | - Added ``RankingType.OG`` & ``RankingType.OG_ZERO_BUILD``
 17 | - Added :meth:`ClientPartyMember.set_jam_emote()`
 18 | - Added :meth:`ClientPartyMember.set_instruments()`
 19 | 
 20 | v0.9.4
 21 | ------
 22 | 
 23 | Changes
 24 | ~~~~~~~
 25 | 
 26 | - :meth:`Client.fetch_ranked_stats()` / :meth:`User.fetch_ranked_stats()` now accepts passing no season which will then automatically fetch the current seasons tracks.
 27 | - (**Breaking**) Removed ``SeasonStartTimestamp``, ``SeasonEndTimestamp``, ``BattlePassStat`` and ``Seasons`` to merge them into a new universal enum :class:`Season`. Affected functions (please re-read the documentation if you use these as they have been updated):
 28 |     - :meth:`Client.fetch_battlepass_level()`
 29 |     - :meth:`Client.fetch_multiple_br_stats`
 30 |     - :meth:`Client.fetch_multiple_br_stats_collections`
 31 |     - :meth:`Client.fetch_multiple_battlepass_levels`
 32 |     - :meth:`Client.fetch_battlepass_level`
 33 |     - :meth:`Client.fetch_ranked_stats`
 34 |     - :meth:`User.fetch_br_stats`
 35 |     - :meth:`User.fetch_br_stats_collection`
 36 |     - :meth:`User.fetch_battlepass_level`
 37 |     - :meth:`User.fetch_ranked_stats`
 38 | 
 39 |     If you were using the old enums, here is how you can replace them:
 40 | 
 41 |     - ``SeasonStartTimestamp.C5SOG.value`` -> ``Season.C5SOG.start_timestamp``
 42 |     - ``SeasonEndTimestamp.C5SOG.value`` -> ``Season.C5SOG.end_timestamp``
 43 |     - ``BattlePassStat.C5SOG.value[0]`` -> ``Season.C5SOG.battlepass_level``
 44 |     - ``Seasons.C5SOG`` -> ``Season.C5SOG.ranked_tracks``
 45 | - :meth:`Client.set_platform()` won't restart the client anymore and will stay in the same party.
 46 | 
 47 | Added
 48 | ~~~~~
 49 | 
 50 | - Added :meth:`Client.fetch_gold_bars()` & :meth:`User.fetch_gold_bars()`
 51 | - Added ``StatsCollectionType.CHARACTER``
 52 | - [:ref:`Ext Commands <rebootpy_ext_commands>`] Added :attr:`ext.commands.Context.member` & :attr:`ext.commands.Context.friend`
 53 | - Added :meth:`ClientPartyMember.set_kicks()`, :meth:`ClientPartyMember.clear_kicks()` & :attr:`PartyMember.kicks`
 54 | - Added :func:`event_party_playlist_request()` and :class:`PlaylistRequest` which is used whenever a party member attempts to change the current playlist.
 55 | - Added ``Season.C6S1``
 56 | .. note::
 57 | 
 58 |     The C5SOG reload ranked season has extended into C6S1 resetting in C6S2. This means C5SOG & C6S1 ranked stats will be identical.
 59 | 
 60 | Bug Fixes
 61 | ~~~~~
 62 | 
 63 | - Fixed an issue parsing squad assignments if the client wasn't leader.
 64 | - Fixed :meth:`Client.fetch_multiple_br_stats_collections` and :meth:`User.fetch_br_stats_collection` incorrectly saying the user was private.
 65 | - Fixed an issue where :meth:`Client.restart` would be stuck forever.
 66 | - Updated member meta to reflect new season changes.
 67 | 
 68 | Removed
 69 | ~~~~~~~
 70 | 
 71 | - Removed all muc (xmpp party chat) related things so if you were relying on any internal events e.g. ``muc_enter``, they have now been removed. This includes ``PartyMember.chatban()`` which has been broken since the party chat changes anyway.
 72 | 
 73 | v0.9.3
 74 | ------
 75 | 
 76 | Changes
 77 | ~~~~~~~
 78 | 
 79 | - (**Breaking**) The :class:`SeasonStartTimestamp`, :class:`SeasonEndTimestamp` & :class:`BattlePassStat` enums have had their values renamed from the ``SEASON_?`` format to ``C?S?`` as it got confusing after Chapter 2. (e.g. ``SEASON_29`` is now ``C5S2``)
 80 | - (**Breaking**) :meth:`Client.fetch_battlepass_level()` & :meth:`Client.fetch_multiple_battlepass_levels()` now take :class:`BattlePassStat` in their ``season`` parameter instead of :class:`int`.
 81 | 
 82 | Added
 83 | ~~~~~
 84 | 
 85 | - Added :meth:`Client.fetch_ranked_stats()` & :meth:`User.fetch_ranked_stats()` (all classes that inherit from :class:`User` like :class:`Friend`, :class:`PartyMember`, etc will all have this method - search ``fetch_ranked_stats`` to see all).
 86 | - Added new enum values for the new season:
 87 | 
 88 |     - ``SeasonStartTimestamp.C5SOG``
 89 | 
 90 |       .. note::
 91 | 
 92 |          This timestamp includes the last 6 hours of C5S4 in order to include all stats from the first day of the season. It's the same timestamp that both `FortniteTracker <https://fortnitetracker.com/>`_ and `fortnite.gg <https://fortnite.gg/>`_ use for this season.
 93 | 
 94 |     - ``SeasonEndTimestamp.C5S4``
 95 |     - ``SeasonEndTimestamp.C5SOG``
 96 |     - ``BattlePassStat.C5SOG``
 97 | 
 98 | - Added ``kill_other_sessions`` parameter to :class:`BasicClient` & :class:`Client`, if you were manually setting the value of the attribute yourself, this'll still work.
 99 | 
100 | Bug Fixes
101 | ~~~~~
102 | 
103 | - Fixed an issue preventing the use of newer aiohttp versions.
104 | - Fixed an issue with certain headless accounts with missing properties.
105 | - Invalid platforms (thanks to messed up non-official clients) won't raise errors and will instead return ``Platform.UNKNOWN``.
106 | - Updated party meta to reflect the new season changes.
107 | 
108 | v0.9.2
109 | ------
110 | 
111 | Changes
112 | ~~~~~~~
113 | 
114 | - (**Breaking**) Switched to the Android client as old iOS client is now buggy (i.e. authorisation code no longer works), meaning all previous device auths will now be invalid.
115 | - Updated default status formatting to reflect new changes.
116 | - Reverted help command changes.
117 | - Increased message character limit from 256 to 2048.
118 | 
119 | Added
120 | ~~~~~
121 | 
122 | - Added :func:`event_device_code_generated()`
123 | - Added :exc:`ChatError`
124 | - Added ``SLEEPING`` to :class:`ReadyState`
125 | 
126 | Bug Fixes
127 | ~~~~~
128 | 
129 | - Fixed an exception being thrown if a party member had an invalid outfit ID.
130 | - Fixed presences sometimes not being able to be parsed if a specific key was missing.
131 | 
132 | v0.9.1
133 | ------
134 | 
135 | Bug Fixes
136 | ~~~~~
137 | 
138 | - Fixed refresh failing due to response missing certain keys.
139 | - Fixed caches not being refreshed while recovering events.
140 | 
141 | 
142 | v0.9.0
143 | ------
144 | 
145 | Major version shift as the library comes closer to the 1.0 release.
146 | 
147 | Added
148 | ~~~~~
149 | 
150 | - Added websocket logger.
151 | 
152 | Bug Fixes
153 | ~~~~~
154 | 
155 | - Fixed some clients not receiving messages.
156 | - Removed the controller icon next to the bots banner, hiding level.
157 | - Websocket connection is now closed gracefully on exit.
158 | 
159 | Removed
160 | ~~~~~~~
161 | 
162 | - Removed :meth:`ClientPartyMember.set_rank()` as it no longer changes visual rank in the lobby.
163 | 
164 | 
165 | v0.0.6
166 | ------
167 | 
168 | Bug Fixes
169 | ~~~~~
170 | 
171 | - Fixed some clients not receiving the same websocket responses as others, causing the websocket connection to be lost.
172 | 
173 | 
174 | v0.0.5
175 | ------
176 | 
177 | Bug Fixes
178 | ~~~~~
179 | 
180 | - Fixed :meth:`Friend.send()`.
181 | - Fixed :meth:`ClientParty.send()`.
182 | - Fixed :meth:`FriendMessage.reply()`.
183 | - Fixed :meth:`PartyMessage.reply()`.
184 | - Fixed :func:`event_party_message()`.
185 | - Fixed :func:`event_friend_message()`.
186 | 
187 | 
188 | v0.0.4
189 | ------
190 | 
191 | Added
192 | ~~~~~
193 | 
194 | - Added :meth:`Client.fetch_creative_island()`.
195 | - Added ``{current_playlist}`` variable to clients status.
196 | 
197 | 
198 | v0.0.3
199 | ------
200 | 
201 | Bug Fixes
202 | ~~~~~~~~~
203 | 
204 | - Fixed :meth:`rebootpy.run_multiple()` throwing an excepton if :class:`AdvancedAuth` is used.
205 | - Fixed ``multiple_clients.py`` example.
206 | 
207 | 
208 | v0.0.2
209 | ------
210 | 
211 | Bug Fixes
212 | ~~~~~~~~~
213 | 
214 | - Fixed ``KeyError: 'party.joininfodata.286331153_j'``.
215 | 
216 | 
217 | Added
218 | ~~~~~
219 | 
220 | - ``SEASON_30`` added to :class:`SeasonStartTimestamp` & ``SEASON_29`` added to :class:`SeasonEndTimestamp`.
221 | 
222 | 
223 | v0.0.1
224 | ------
225 | 
226 | Changes
227 | ~~~~~~~
228 | 
229 | - (**Breaking**) Removed :class:`EmailAndPasswordAuth`.
230 | - (**Breaking**) :class:`AdvancedAuth` no longer accepts `email` & `password` and instead by default uses device code if there are no device auths.
231 | - (**Breaking**) As featured & daily items are no longer different in the store, ``featured_items`` & ``daily_items`` have been combined to :attr:`Store.items` which uses the :class:`StoreItem` type.
232 | - Added ``prompt_device_code`` & ``open_link_in_browser`` parameters to :class:`AdvancedAuth`.
233 | 
234 | 
235 | Added
236 | ~~~~~
237 | 
238 | - Added functionality for new ``cosmeticStats`` values in party member meta.
239 | 
240 |   - Added :meth:`ClientPartyMember.equip_crown()`.
241 |   - Added :meth:`ClientPartyMember.set_victory_crowns()`.  
242 |   - Added :meth:`ClientPartyMember.set_rank()`.  
243 |   - Added :attr:`PartyMember.has_crown`.
244 |   - Added :attr:`PartyMember.victory_crowns`.
245 |   - Added :attr:`PartyMember.rank`.
246 | 
247 | - Added :class:`DeviceCodeAuth`.
248 | 
249 | 
250 | Removed
251 | ~~~~~~~
252 | 
253 | - Removed ``Client.fetch_user_by_email()`` as it had been deprecated by epic.
254 | 
255 | 
256 | Bug Fixes
257 | ~~~~~~~~~
258 | 
259 | - Updated party & party member meta to reflect changes from C4 & C5 which completely broke them.
260 | - Fixed broken events which either never dispatched or returned None.
261 | - Fixed :meth:`Client.fetch_item_shop()`.
262 | 


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | # flake8: noqa
  2 | 
  3 | # Configuration file for the Sphinx documentation builder.
  4 | #
  5 | # This file only contains a selection of the most common options. For a full
  6 | # list see the documentation:
  7 | # http://www.sphinx-doc.org/en/master/config
  8 | 
  9 | # -- Path setup --------------------------------------------------------------
 10 | 
 11 | # If extensions (or modules to document with autodoc) are in another directory,
 12 | # add these directories to sys.path here. If the directory is relative to the
 13 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 14 | #
 15 | import os
 16 | import sys
 17 | import re
 18 | 
 19 | sys.path.insert(0, os.path.abspath('./..'))
 20 | sys.path.append(os.path.abspath('localexts'))
 21 | 
 22 | 
 23 | # -- Project information -----------------------------------------------------
 24 | 
 25 | project = 'rebootpy'
 26 | copyright = '2019-2021, Terbau'
 27 | author = 'Terbau'
 28 | 
 29 | version = ''
 30 | with open('../rebootpy/__init__.py') as f:
 31 |     version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1)
 32 | 
 33 | # The full version, including alpha/beta/rc tags.
 34 | release = version
 35 | 
 36 | 
 37 | # -- General configuration ---------------------------------------------------
 38 | 
 39 | # Add any Sphinx extension module names here, as strings. They can be
 40 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 41 | # ones.
 42 | extensions = [
 43 |     'sphinx.ext.autodoc', 
 44 |     'sphinx.ext.coverage', 
 45 |     'sphinx.ext.napoleon',
 46 |     'sphinx.ext.intersphinx',
 47 |     'sphinxcontrib_trio',
 48 |     'viewcode',
 49 |     'attributetable',
 50 | ]
 51 | 
 52 | 
 53 | autodoc_member_order = 'bysource'
 54 | autodoc_typehints = 'none'
 55 | 
 56 | # Links used for cross-referencing stuff in other documentation
 57 | intersphinx_mapping = {
 58 |   'py': ('https://docs.python.org/3', None),
 59 |   'aiohttp': ('https://aiohttp.readthedocs.io/en/stable/', None),
 60 |   'requests': ('http://docs.python-requests.org/en/latest/', 'requests.inv'),
 61 |   'aioxmpp': ('https://docs.zombofant.net/aioxmpp/devel/', None)
 62 | }
 63 | 
 64 | rst_prolog = """
 65 | .. |coro| replace:: This function is a |coroutine_link|_.
 66 | .. |maybecoro| replace:: This function *could be a* |coroutine_link|_.
 67 | .. |coroutine_link| replace:: *coroutine*
 68 | .. _coroutine_link: https://docs.python.org/3/library/asyncio-task.html#coroutine
 69 | """
 70 | 
 71 | # Add any paths that contain templates here, relative to this directory.
 72 | templates_path = ['_templates']
 73 | 
 74 | # List of patterns, relative to source directory, that match files and
 75 | # directories to ignore when looking for source files.
 76 | # This pattern also affects html_static_path and html_extra_path.
 77 | exclude_patterns = []
 78 | 
 79 | master_doc = 'index'
 80 | 
 81 | # -- Options for HTML output -------------------------------------------------
 82 | 
 83 | # The theme to use for HTML and HTML Help pages.  See the documentation for
 84 | # a list of builtin themes.
 85 | #
 86 | html_theme = 'furo'
 87 | 
 88 | # Add any paths that contain custom static files (such as style sheets) here,
 89 | # relative to this directory. They are copied after the builtin static files,
 90 | # so a file named "default.css" will overwrite the builtin "default.css".
 91 | html_static_path = ['_static']
 92 | 
 93 | html_js_files = [
 94 |     'custom.js',
 95 |     'settings.js',
 96 | ]
 97 | 
 98 | html_css_files = [
 99 |     'style.css'
100 | ]
101 | 
102 | def setup(app):
103 |     pass
104 | 


--------------------------------------------------------------------------------
/docs/ext/commands/api.rst:
--------------------------------------------------------------------------------
  1 | .. currentmodule:: rebootpy
  2 | 
  3 | API Reference
  4 | ===============
  5 | 
  6 | The following section outlines the API of rebootpy's command extension module.
  7 | 
  8 | .. _ext_commands_api_bot:
  9 | 
 10 | Bot
 11 | ----
 12 | 
 13 | .. attributetable:: rebootpy.ext.commands.Bot
 14 | 
 15 | .. autoclass:: rebootpy.ext.commands.Bot
 16 |     :members:
 17 |     :inherited-members:
 18 | 
 19 | .. _ext_commands_api_events:
 20 | 
 21 | Event Reference
 22 | -----------------
 23 | 
 24 | These events function similar to :ref:`the regular events <rebootpy-api-events>`, except they
 25 | are custom to the command extension module.
 26 | 
 27 | .. function:: event_command_error(ctx, error)
 28 | 
 29 |     An error handler that is called when an error is raised
 30 |     inside a command either through user input error, check
 31 |     failure, or an error in your own code.
 32 | 
 33 |     Command error handlers are raised in a specific order. Returning
 34 |     ``False`` in any of them will invoke the next handler in the chain. If
 35 |     there are no handlers left to call, then the error is printed to
 36 |     stderr (console).
 37 | 
 38 |     The order goes as follows:
 39 |     1. The local command error handler is called. (Handler specified by decorating a command error handler with :meth:`Command.error()`)
 40 |     2. The local cog command error handler is called.
 41 |     3. All :func:`.event_command_error()` handlers are called
 42 |     simultaneously. If any of them return False, then the error will
 43 |     be printed.
 44 | 
 45 |     :param ctx: The invocation context.
 46 |     :type ctx: :class:`.Context`
 47 |     :param error: The error that was raised.
 48 |     :type error: :class:`.CommandError` derived
 49 | 
 50 | .. function:: event_command(ctx)
 51 | 
 52 |     An event that is called when a command is found and is about to be invoked.
 53 | 
 54 |     This event is called regardless of whether the command itself succeeds via
 55 |     error or completes.
 56 | 
 57 |     :param ctx: The invocation context.
 58 |     :type ctx: :class:`.Context`
 59 | 
 60 | .. function:: event_command_completion(ctx)
 61 | 
 62 |     An event that is called when a command has completed its invocation.
 63 | 
 64 |     This event is called only if the command succeeded, i.e. all checks have
 65 |     passed and the user input it correctly.
 66 | 
 67 |     :param ctx: The invocation context.
 68 |     :type ctx: :class:`.Context`
 69 | 
 70 | .. _ext_commands_api_command:
 71 | 
 72 | Command
 73 | --------
 74 | 
 75 | command()
 76 | ~~~~~~~~~
 77 | 
 78 | .. autofunction:: rebootpy.ext.commands.command
 79 | 
 80 | group()
 81 | ~~~~~~~
 82 | 
 83 | .. autofunction:: rebootpy.ext.commands.group
 84 | 
 85 | Command
 86 | ~~~~~~~
 87 | 
 88 | .. attributetable:: rebootpy.ext.commands.Command
 89 | 
 90 | .. autoclass:: rebootpy.ext.commands.Command
 91 |     :members:
 92 |     :special-members: __call__
 93 | 
 94 | Group
 95 | ~~~~~
 96 | 
 97 | .. attributetable:: rebootpy.ext.commands.Group
 98 | 
 99 | .. autoclass:: rebootpy.ext.commands.Group
100 |     :members:
101 |     :inherited-members:
102 | 
103 | GroupMixin
104 | ~~~~~~~~~~
105 | 
106 | .. attributetable:: rebootpy.ext.commands.GroupMixin
107 | 
108 | .. autoclass:: rebootpy.ext.commands.GroupMixin
109 |     :members:
110 | 
111 | .. _ext_commands_api_cogs:
112 | 
113 | Cogs
114 | ------
115 | 
116 | Cog
117 | ~~~
118 | 
119 | .. attributetable:: rebootpy.ext.commands.Cog
120 | 
121 | .. autoclass:: rebootpy.ext.commands.Cog
122 |     :members:
123 | 
124 | CogMeta
125 | ~~~~~~~
126 | 
127 | .. attributetable:: rebootpy.ext.commands.CogMeta
128 | 
129 | .. autoclass:: rebootpy.ext.commands.CogMeta
130 |     :members:
131 | 
132 | .. _ext_commands_api_formatters:
133 | 
134 | Help Commands
135 | -----------------
136 | 
137 | HelpCommand
138 | ~~~~~~~~~~~
139 | 
140 | .. attributetable:: rebootpy.ext.commands.HelpCommand
141 | 
142 | .. autoclass:: rebootpy.ext.commands.HelpCommand
143 |     :members:
144 | 
145 | FortniteHelpCommand
146 | ~~~~~~~~~~~~~~~~~~~
147 | 
148 | .. attributetable:: rebootpy.ext.commands.FortniteHelpCommand
149 | 
150 | .. autoclass:: rebootpy.ext.commands.FortniteHelpCommand
151 |     :members:
152 |     :exclude-members: send_bot_help, send_cog_help, send_group_help, send_command_help, prepare_help_command
153 | 
154 | Paginator
155 | ~~~~~~~~~
156 | 
157 | .. attributetable:: rebootpy.ext.commands.Paginator
158 | 
159 | .. autoclass:: rebootpy.ext.commands.Paginator
160 |     :members:
161 | 
162 | Enums
163 | ------
164 | 
165 | .. class:: rebootpy.ext.commands.BucketType
166 | 
167 |     Specifies a type of bucket for, e.g. a cooldown.
168 | 
169 |     .. attribute:: default
170 | 
171 |         The default bucket operates on a global basis.
172 |     .. attribute:: user
173 | 
174 |         The user bucket operates on a per-user basis.
175 | 
176 | 
177 | .. _ext_commands_api_checks:
178 | 
179 | Checks
180 | -------
181 | 
182 | .. autofunction:: rebootpy.ext.commands.check
183 | 
184 | .. autofunction:: rebootpy.ext.commands.check_any
185 | 
186 | .. autofunction:: rebootpy.ext.commands.cooldown
187 | 
188 | .. autofunction:: rebootpy.ext.commands.max_concurrency
189 | 
190 | .. autofunction:: rebootpy.ext.commands.before_invoke
191 | 
192 | .. autofunction:: rebootpy.ext.commands.after_invoke
193 | 
194 | .. autofunction:: rebootpy.ext.commands.party_only
195 | 
196 | .. autofunction:: rebootpy.ext.commands.dm_only
197 | 
198 | .. autofunction:: rebootpy.ext.commands.is_owner
199 | 
200 | .. _ext_commands_api_context:
201 | 
202 | Context
203 | --------
204 | 
205 | .. attributetable:: rebootpy.ext.commands.Context
206 | 
207 | .. autoclass:: rebootpy.ext.commands.Context
208 |     :members:
209 |     :inherited-members:
210 | 
211 | .. _ext_commands_api_converters:
212 | 
213 | Converters
214 | ------------
215 | 
216 | .. autoclass:: rebootpy.ext.commands.Converter
217 |     :members:
218 | 
219 | .. autoclass:: rebootpy.ext.commands.UserConverter
220 |     :members:
221 | 
222 | .. autoclass:: rebootpy.ext.commands.FriendConverter
223 |     :members:
224 | 
225 | .. autoclass:: rebootpy.ext.commands.PartyMemberConverter
226 |     :members:
227 | 
228 | .. data:: ext.commands.Greedy
229 | 
230 |     A special converter that greedily consumes arguments until it can't.
231 |     As a consequence of this behaviour, most input errors are silently discarded,
232 |     since it is used as an indicator of when to stop parsing.
233 | 
234 |     When a parser error is met the greedy converter stops converting, undoes the
235 |     internal string parsing routine, and continues parsing regularly.
236 | 
237 |     For example, in the following code:
238 | 
239 |     .. code-block:: python3
240 | 
241 |         @commands.command()
242 |         async def test(ctx, numbers: Greedy[int], reason: str):
243 |             await ctx.send("numbers: {}, reason: {}".format(numbers, reason))
244 | 
245 |     An invocation of ``[p]test 1 2 3 4 5 6 hello`` would pass ``numbers`` with
246 |     ``[1, 2, 3, 4, 5, 6]`` and ``reason`` with ``hello``\.
247 | 
248 |     For more information, check :ref:`ext_commands_special_converters`.
249 | 
250 | .. _ext_commands_api_errors:
251 | 
252 | Exceptions
253 | -----------
254 | 
255 | .. autoexception:: rebootpy.ext.commands.CommandError
256 |     :members:
257 | 
258 | .. autoexception:: rebootpy.ext.commands.ConversionError
259 |     :members:
260 | 
261 | .. autoexception:: rebootpy.ext.commands.MissingRequiredArgument
262 |     :members:
263 | 
264 | .. autoexception:: rebootpy.ext.commands.ArgumentParsingError
265 |     :members:
266 | 
267 | .. autoexception:: rebootpy.ext.commands.UnexpectedQuoteError
268 |     :members:
269 | 
270 | .. autoexception:: rebootpy.ext.commands.InvalidEndOfQuotedStringError
271 |     :members:
272 | 
273 | .. autoexception:: rebootpy.ext.commands.ExpectedClosingQuoteError
274 |     :members:
275 | 
276 | .. autoexception:: rebootpy.ext.commands.BadArgument
277 |     :members:
278 | 
279 | .. autoexception:: rebootpy.ext.commands.BadUnionArgument
280 |     :members:
281 | 
282 | .. autoexception:: rebootpy.ext.commands.PrivateMessageOnly
283 |     :members:
284 | 
285 | .. autoexception:: rebootpy.ext.commands.PartyMessageOnly
286 |     :members:
287 | 
288 | .. autoexception:: rebootpy.ext.commands.CheckFailure
289 |     :members:
290 | 
291 | .. autoexception:: rebootpy.ext.commands.CheckAnyFailure
292 |     :members:
293 | 
294 | .. autoexception:: rebootpy.ext.commands.CommandNotFound
295 |     :members:
296 | 
297 | .. autoexception:: rebootpy.ext.commands.DisabledCommand
298 |     :members:
299 | 
300 | .. autoexception:: rebootpy.ext.commands.CommandInvokeError
301 |     :members:
302 | 
303 | .. autoexception:: rebootpy.ext.commands.TooManyArguments
304 |     :members:
305 | 
306 | .. autoexception:: rebootpy.ext.commands.UserInputError
307 |     :members:
308 | 
309 | .. autoexception:: rebootpy.ext.commands.CommandOnCooldown
310 |     :members:
311 | 
312 | .. autoexception:: rebootpy.ext.commands.MaxConcurrencyReached
313 |     :members:
314 | 
315 | .. autoexception:: rebootpy.ext.commands.NotOwner
316 |     :members:
317 | 
318 | .. autoexception:: rebootpy.ext.commands.ExtensionError
319 |     :members:
320 | 
321 | .. autoexception:: rebootpy.ext.commands.ExtensionAlreadyLoaded
322 |     :members:
323 | 
324 | .. autoexception:: rebootpy.ext.commands.ExtensionNotLoaded
325 |     :members:
326 | 
327 | .. autoexception:: rebootpy.ext.commands.ExtensionMissingEntryPoint
328 |     :members:
329 | 
330 | .. autoexception:: rebootpy.ext.commands.ExtensionFailed
331 |     :members:
332 | 
333 | .. autoexception:: rebootpy.ext.commands.ExtensionNotFound
334 |     :members:
335 | 


--------------------------------------------------------------------------------
/docs/ext/commands/cogs.rst:
--------------------------------------------------------------------------------
  1 | .. currentmodule:: rebootpy
  2 | 
  3 | .. _ext_commands_cogs:
  4 | 
  5 | Cogs
  6 | ======
  7 | 
  8 | There comes a point in your bot's development when you want to organize a collection of commands, event handlers, and some state into one class. Cogs allow you to do just that.
  9 | 
 10 | The gist:
 11 | 
 12 | - Each cog is a Python class that subclasses :class:`.commands.Cog`.
 13 | - Every command is marked with the :func:`.commands.command` decorator.
 14 | - Every event handler is marked with the :meth:`.commands.Cog.event` decorator.
 15 | - Cogs are then registered with the :meth:`.Bot.add_cog` call.
 16 | - Cogs are subsequently removed with the :meth:`.Bot.remove_cog` call.
 17 | 
 18 | It should be noted that cogs are typically used alongside with :ref:`ext_commands_extensions`.
 19 | 
 20 | Quick Example
 21 | ---------------
 22 | 
 23 | This example cog defines a ``Greetings`` category for your commands, with a single :ref:`command <ext_commands_commands>` named ``hello`` as well as a listener to listen to an :ref:`Event <rebootpy-api-events>`.
 24 | 
 25 | .. code-block:: python3
 26 | 
 27 |     class Greetings(commands.Cog):
 28 |         def __init__(self, bot):
 29 |             self.bot = bot
 30 |             self._last_member = None
 31 | 
 32 |         @commands.Cog.event()
 33 |         async def event_party_member_join(self, member):
 34 |             party = member.party
 35 |             await party.send('Welcome {0.display_name}.'.format(member))
 36 | 
 37 |         @commands.command()
 38 |         async def hello(self, ctx, *, member: rebootpy.Member = None):
 39 |             """Says hello"""
 40 |             member = member or ctx.author
 41 |             if self._last_member is None or self._last_member.id != member.id:
 42 |                 await ctx.send('Hello {0.display_name}~'.format(member))
 43 |             else:
 44 |                 await ctx.send('Hello {0.display_name}... This feels familiar.'.format(member))
 45 |             self._last_member = member
 46 | 
 47 | A couple of technical notes to take into consideration:
 48 | 
 49 | - All event handler must be explicitly marked via decorator, :meth:`~.commands.Cog.event`.
 50 | - The name of the cog is automatically derived from the class name but can be overridden. See :ref:`ext_commands_cogs_meta_options`.
 51 | - All commands must now take a ``self`` parameter to allow usage of instance attributes that can be used to maintain state.
 52 | 
 53 | Cog Registration
 54 | -------------------
 55 | 
 56 | Once you have defined your cogs, you need to tell the bot to register the cogs to be used. We do this via the :meth:`~.commands.Bot.add_cog` method.
 57 | 
 58 | .. code-block:: python3
 59 | 
 60 |     bot.add_cog(Greetings(bot))
 61 | 
 62 | This binds the cog to the bot, adding all commands and listeners to the bot automatically.
 63 | 
 64 | Note that we reference the cog by name, which we can override through :ref:`ext_commands_cogs_meta_options`. So if we ever want to remove the cog eventually, we would have to do the following.
 65 | 
 66 | .. code-block:: python3
 67 | 
 68 |     bot.remove_cog('Greetings')
 69 | 
 70 | Using Cogs
 71 | -------------
 72 | 
 73 | Just as we remove a cog by its name, we can also retrieve it by its name as well. This allows us to use a cog as an inter-command communication protocol to share data. For example:
 74 | 
 75 | .. code-block:: python3
 76 |     :emphasize-lines: 22,24
 77 | 
 78 |     class Economy(commands.Cog):
 79 |         ...
 80 | 
 81 |         async def withdraw_money(self, member, money):
 82 |             # implementation here
 83 |             ...
 84 | 
 85 |         async def deposit_money(self, member, money):
 86 |             # implementation here
 87 |             ...
 88 | 
 89 |     class Gambling(commands.Cog):
 90 |         def __init__(self, bot):
 91 |             self.bot = bot
 92 | 
 93 |         def coinflip(self):
 94 |             return random.randint(0, 1)
 95 | 
 96 |         @commands.command()
 97 |         async def gamble(self, ctx, money: int):
 98 |             """Gambles some money."""
 99 |             economy = self.bot.get_cog('Economy')
100 |             if economy is not None:
101 |                 await economy.withdraw_money(ctx.author, money)
102 |                 if self.coinflip() == 1:
103 |                     await economy.deposit_money(ctx.author, money * 1.5)
104 | 
105 | .. _ext_commands_cogs_special_methods:
106 | 
107 | Special Methods
108 | -----------------
109 | 
110 | As cogs get more complicated and have more commands, there comes a point where we want to customise the behaviour of the entire cog or bot.
111 | 
112 | They are as follows:
113 | 
114 | - :meth:`.Cog.cog_unload`
115 | - :meth:`.Cog.cog_check`
116 | - :meth:`.Cog.cog_command_error`
117 | - :meth:`.Cog.cog_before_invoke`
118 | - :meth:`.Cog.cog_after_invoke`
119 | - :meth:`.Cog.bot_check`
120 | - :meth:`.Cog.bot_check_once`
121 | 
122 | You can visit the reference to get more detail.
123 | 
124 | .. _ext_commands_cogs_meta_options:
125 | 
126 | Meta Options
127 | --------------
128 | 
129 | At the heart of a cog resides a metaclass, :class:`.commands.CogMeta`, which can take various options to customise some of the behaviour. To do this, we pass keyword arguments to the class definition line. For example, to change the cog name we can pass the ``name`` keyword argument as follows:
130 | 
131 | .. code-block:: python3
132 | 
133 |     class MyCog(commands.Cog, name='My Cog'):
134 |         pass
135 | 
136 | To see more options that you can set, see the documentation of :class:`.commands.CogMeta`.
137 | 
138 | Inspection
139 | ------------
140 | 
141 | Since cogs ultimately are classes, we have some tools to help us inspect certain properties of the cog.
142 | 
143 | 
144 | To get a :class:`list` of commands, we can use :meth:`.Cog.get_commands`. ::
145 | 
146 |     >>> cog = bot.get_cog('Greetings')
147 |     >>> commands = cog.get_commands()
148 |     >>> print([c.name for c in commands])
149 | 
150 | If we want to get the subcommands as well, we can use the :meth:`.Cog.walk_commands` generator. ::
151 | 
152 |     >>> print([c.qualified_name for c in cog.walk_commands()])
153 | 
154 | To do the same with event handler, we can query them with :meth:`.Cog.get_event_handlers`. This returns a list of tuples -- the first element being the listener name and the second one being the actual function itself. ::
155 | 
156 |     >>> for name, func in cog.get_listeners():
157 |     ...     print(name, '->', func)
158 | 


--------------------------------------------------------------------------------
/docs/ext/commands/extensions.rst:
--------------------------------------------------------------------------------
 1 | .. currentmodule:: rebootpy
 2 | 
 3 | .. _ext_commands_extensions:
 4 | 
 5 | Extensions
 6 | =============
 7 | 
 8 | There comes a time in the bot development when you want to extend the bot functionality at run-time and quickly unload and reload code (also called hot-reloading). The command framework comes with this ability built-in, with a concept called **extensions**.
 9 | 
10 | Primer
11 | --------
12 | 
13 | An extension at its core is a python file with an entry point called ``extension_setup``. This setup must be a plain Python function (not a coroutine). It takes a single parameter -- the :class:`~.commands.Bot` that loads the extension.
14 | 
15 | An example extension looks like this:
16 | 
17 | .. code-block:: python3
18 |     :caption: hello.py
19 |     :emphasize-lines: 7,8
20 | 
21 |     from rebootpy.ext import commands
22 | 
23 |     @commands.command()
24 |     async def hello(ctx):
25 |         await ctx.send('Hello {0.display_name}.'.format(ctx.author))
26 | 
27 |     def extension_setup(bot):
28 |         bot.add_command(hello)
29 | 
30 | In this example we define a simple command, and when the extension is loaded this command is added to the bot. Now the final step to this is loading the extension, which we do by calling :meth:`.commands.Bot.load_extension`. To load this extension we call ``bot.load_extension('hello')``.
31 | 
32 | .. admonition:: Cogs
33 |     :class: helpful
34 | 
35 |     Extensions are usually used in conjunction with cogs. To read more about them, check out the documentation, :ref:`ext_commands_cogs`.
36 | 
37 | .. note::
38 | 
39 |     Extension paths are ultimately similar to the import mechanism. What this means is that if there is a folder, then it must be dot-qualified. For example to load an extension in ``plugins/hello.py`` then we use the string ``plugins.hello``.
40 | 
41 | Reloading
42 | -----------
43 | 
44 | When you make a change to the extension and want to reload the references, the library comes with a function to do this for you, :meth:`Bot.reload_extension`.
45 | 
46 | .. code-block:: python3
47 | 
48 |     >>> bot.reload_extension('hello')
49 | 
50 | Once the extension reloads, any changes that we did will be applied. This is useful if we want to add or remove functionality without restarting our bot. If an error occurred during the reloading process, the bot will pretend as if the reload never happened.
51 | 
52 | Cleaning Up
53 | -------------
54 | 
55 | Although rare, sometimes an extension needs to clean-up or know when it's being unloaded. For cases like these, there is another entry point named ``cog_teardown`` which is similar to ``extension_setup`` except called when the extension is unloaded.
56 | 
57 | .. code-block:: python3
58 |     :caption: basic_ext.py
59 | 
60 |     def extension_setup(bot):
61 |         print('I am being loaded!')
62 | 
63 |     def cog_teardown(bot):
64 |         print('I am being unloaded!')


--------------------------------------------------------------------------------
/docs/ext/commands/index.rst:
--------------------------------------------------------------------------------
 1 | .. _rebootpy_ext_commands:
 2 | 
 3 | Commands Framework
 4 | ====================================================
 5 | 
 6 | This is the documentation for the bot commands framework ported from `discord.py <https://github.com/Rapptz/discord.py/>`_. If you ever need help, please do not
 7 | ask the discord.py community. They're not maintainers of this ported version and all questions should be asked either in an issue or in the discord support server linked
 8 | in rebootpy's readme.
 9 | 
10 | 
11 | .. toctree::
12 |     :maxdepth: 3
13 | 
14 |     commands
15 |     cogs
16 |     extensions
17 |     api


--------------------------------------------------------------------------------
/docs/faq.rst:
--------------------------------------------------------------------------------
  1 | .. currentmodule:: rebootpy
  2 | 
  3 | Frequently Asked Questions (FAQ)
  4 | ================================
  5 | 
  6 | Authentication
  7 | --------------
  8 | 
  9 | Why are there so many different authentication methods?
 10 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 11 | 
 12 | With the deprecation of email and password authentication, there was
 13 | a need of different ways to authenticate. Therefore, rebootpy tries to offer
 14 | as many different authentication methods as possible. You can read more about the
 15 | different possibilities over `here <https://github.com/MixV2/EpicResearch/tree/master/docs/auth/grant_types>`_.
 16 | 
 17 | 
 18 | Which authentication method should I use?
 19 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 20 | 
 21 | The answer to this question depends completely on what information you already
 22 | have, for example, if you've just made a fresh Epic Games account, I'd use
 23 | AdvancedAuth or my other library `DeviceAuthGenerator <https://github.com/xMistt/DeviceAuthGenerator>`_
 24 | first in order to generate device auths, and then after that I'd just use the
 25 | DeviceAuth authentication method. If you are unsure how to use :class:`AdvancedAuth`,
 26 | you can take a look at the `examples folder <https://github.com/xMistt/rebootpy/tree/main/examples>`_
 27 | where it's used in all of the examples.
 28 | 
 29 | 
 30 | Whats the best way of storing the device auth details of an account?
 31 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 32 | 
 33 | This depends on the complexity of the bot with multiple accounts in mind. For
 34 | a program running a single bot, the easiest method of storage would be using
 35 | a json file. A method for this is showcased in all `examples <https://github.com/xMistt/rebootpy/tree/main/examples>`_.
 36 | 
 37 | For bots with multiple accounts I suggest using a database for the single reason
 38 | that file io is blocking and sometimes the operating system might spit out
 39 | errors because too many files are opened at the same time. 
 40 | 
 41 | **Note:** If you're going to use a database for anything in the same program as
 42 | the fortnite bot, please use an asynchronous database library. I can personally
 43 | recommend using a postgresql database and `asyncpg <https://github.com/MagicStack/asyncpg>`_
 44 | as the library.
 45 | 
 46 | 
 47 | General
 48 | -------
 49 | 
 50 | What is async/await and how do I use it?
 51 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 52 | 
 53 | Asynchronous programming lets the program sort of perform multiple actions at
 54 | once. For newcomers to python/programming in general, the `discord.py faq <https://discordpy.readthedocs.io/en/latest/faq.html#coroutines>`_
 55 | has a great simplified explanation of its basic concepts. For people with existing
 56 | knowledge of asynchronous programming that want to know even more about it, I can
 57 | suggest `this article <https://realpython.com/async-io-python/>`_ on it. As well as
 58 | breakign down pretty much all you need to know about asynchronous programming, it
 59 | also explains the differences between multiprocessing, threading and asyncio in python
 60 | in an understandable way.
 61 | 
 62 | 
 63 | Where can I find usage examples?
 64 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 65 | 
 66 | You can find example code in the `examples folder <https://github.com/xMistt/rebootpy/tree/main/examples>`_
 67 | in the github repository.
 68 | 
 69 | 
 70 | How can I access the clients current party object?
 71 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 72 | 
 73 | The clients current party object can be accessed through :attr:`Client.party`.
 74 | 
 75 | 
 76 | How can I access the clients current party member object?
 77 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 78 | 
 79 | The clients current party member object can be accessed through :attr:`ClientParty.me`.
 80 | Example usage: ``await client.party.me.set_emote('EID_Floss')``
 81 | 
 82 | 
 83 | How can I send a DM?
 84 | ~~~~~~~~~~~~~~~~~~~~
 85 | 
 86 | To send a DM you first need the :class:`Friend` object of the friend you
 87 | want to send the dm to and then use :meth:`Friend.send()`. Example: ::
 88 | 
 89 |     friend = client.get_friend('7e9f8dd37a924496bc5083733887b44c')
 90 |     await friend.send('Hello friend!')
 91 | 
 92 | If you want to respond to a friend message in :func:`event_friend_message()`, you
 93 | can do this by using :meth:`FriendMessage.reply()`. Example: ::
 94 | 
 95 |     @client.event
 96 |     async def event_friend_message(message):
 97 |         await message.reply('Thanks for the message!')
 98 | 
 99 |         # Not as clean but would still work:
100 |         await message.author.send('Thanks for the message!')
101 | 
102 | 
103 | How can I set a status?
104 | ~~~~~~~~~~~~~~~~~~~~~~~
105 | You can pass a status message for the client to use when creating 
106 | client. 
107 | 
108 | .. code-block:: python3
109 | 
110 |     client = rebootpy.Client(
111 |         auth=rebootpy.Auth, // Here goes an authentication method like rebootpy.AdvancedAuth or rebootpy.DeviceAuth
112 |         status="This is my status"
113 |     )
114 | 
115 | .. warning::
116 | 
117 |     This will override all status messages in the future. The standard
118 |     status message (``In Lobby - {current_playlist}``) will also be overridden.
119 |     If you just want to send a status message once and not override all
120 |     upcoming status messages, :meth:`Client.send_presence` is the function
121 |     you are looking for.
122 | 
123 | Alternatively you can change the presence with :meth:`Client.set_presence`.
124 | 
125 | 
126 | How can I get the CID of a skin?
127 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128 | 
129 | There is no good easy way to obtain these yourself. However, there are some
130 | APIs made by other people that you can use to find cosmetic IDs, I recommend:
131 | - `NotOfficer's API <https://fortnite-api.com/>`_.
132 | 
133 | 
134 | How can I get a users K/D or Win Percentage?
135 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136 | 
137 | Since the stats request does not return a K/D or win percentage, you must
138 | calculate them yourself. Just to make it easy :class:`StatsV2` includes 
139 | functions that calculates these values for you.
140 | 
141 | Take a closer look at :meth:`StatsV2.get_kd` and 
142 | :meth:`StatsV2.get_winpercentage`.
143 | 
144 | 
145 | Why are some cosmetics invisible/dances not playing?
146 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147 | 
148 | Since ~C4S3, cosmetics have been stored in 2 paths, some in the old folder but the majority in a new folder
149 | called BRCosmetics. Since the path in rebootpy is hard-coded, theres no good way of getting the correct path
150 | since it would require installing the entire game to wherever your instance of rebootpy is running. However,
151 | the best way I have found is to use a third party API such as Fortnite-API to get the path.
152 | 
153 | Outfits do not have this issue anymore as they no longer require a path at all, so you can just pass the ID
154 | of any outfit to :meth:`ClientPartyMember.set_outfit()` and regardless of its location, it will show correctly (as long as the ID is valid).
155 | 
156 | **Guide to find path using Fortnite-API:** 
157 | 
158 | 1. Head over to the `Fortnite-API docs <https://dash.fortnite-api.com/endpoints/cosmetics>`_.
159 | 2. Choose an endpoint that you want to use to lookup cosmetics, either via ID or name.
160 | 3. The response will have a key called `path` in `data`, if it contains BRCosmetic, just pass
161 | the plain ID to the `set_` function as this is the path that the library is already using.
162 | 
163 | 4. If the cosmetic is in the original path, use
164 | 
165 | .. code-block::
166 | 
167 |     /Game/Athena/Items/Cosmetics/<CosmeticPath>/
168 | 
169 | as the path, example usage for a dance would be:
170 | 
171 | .. code-block::
172 | 
173 |     await bot.party.me.set_emote('/Game/Athena/Items/Cosmetics/Dances/EID_Coronet.EID_Coronet')
174 | 
175 | 
176 | **Here is an example of using Fortnite-API to get the correct path for a dance:**
177 | 
178 | .. code-block::
179 | 
180 |     @bot.command()
181 |     async def emote(ctx, *, search: str):
182 |         async with aiohttp.ClientSession() as session:
183 |             async with session.request(
184 |                 method="GET",
185 |                 url="https://fortnite-api.com/v2/cosmetics/br/search?name=" \
186 |                 f"{search}&matchMethod=contains&backendType=AthenaDance"
187 |             ) as request:
188 |                 if request.status == 404:
189 |                     return await ctx.send('Dance not found!')
190 | 
191 |                 data = await request.json()
192 | 
193 |         if "brcosmetics" in data['data']['path'].lower():
194 |             await bot.party.me.set_emote(asset=data['data']['id'])
195 |         else:
196 |             path = f"/Game/Athena/Items/Cosmetics/Dances/{data['data']['id']}.{data['data']['id']}"
197 |             await bot.party.me.set_emote(asset=path)
198 | 
199 | 
200 | A full example can be found `here <https://github.com/xMistt/rebootpy/blob/main/examples/fortnite_api_path.py>`_.
201 | 
202 | 
203 | 
204 | 


--------------------------------------------------------------------------------
/docs/help.rst:
--------------------------------------------------------------------------------
 1 | .. currentmodule:: rebootpy
 2 | 
 3 | Need more help?
 4 | ===============
 5 | 
 6 | Support Discord
 7 | ---------------
 8 | 
 9 | Feel free to join `this discord <https://discord.gg/rnk869s>`_. Asking question about the library there will greatly speed up the average response time as there are multiple experienced members (hopefully) available that can offer you help. Keep in mind that this is a discord server for general epicgames app development. Use ``#fortnitepy-help`` for rebootpy related questions.
10 | 
11 | If you need to get in contact with me directly, you can join the discord above and then ping me (`mistxoli``).
12 | 
13 | 
14 | Github Issue Tracker
15 | --------------------
16 | 
17 | If you want to report a bug or suggest a new feature you can do this on the `github issue tracker <https://github.com/xMistt/rebootpy/issues>`_. Please include as much information as possible so it will be easier to understand.
18 | 
19 | 
20 | External links
21 | --------------
22 | 
23 | * `rebootpy Github <https://github.com/xMistt/rebootpy>`_
24 | * `Python documentation <https://docs.python.org/3/>`_
25 | * `Async/Await guide (asyncio) <https://realpython.com/async-io-python/>`_
26 | * `Discord.py documentation <https://discordpy.readthedocs.io/en/latest/>`_


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | Welcome to rebootpy's documentation!
 2 | ======================================
 3 | 
 4 | Documentation Contents
 5 | ----------------------
 6 | 
 7 | .. toctree::
 8 |    :maxdepth: 3
 9 |    
10 |    intro
11 |    api
12 | 
13 | Extensions
14 | ----------
15 | 
16 | .. toctree::
17 |   :maxdepth: 3
18 | 
19 |   ext/commands/index.rst
20 | 
21 | Other
22 | -----
23 | 
24 | .. toctree::
25 |   :maxdepth: 3
26 | 
27 |   faq
28 |   usedby
29 |   help
30 | 
31 | Changelogs
32 | -----------
33 | 
34 | .. toctree::
35 |   :maxdepth: 2
36 | 
37 |   changelog
38 | 
39 | 
40 | If you still can't find what you are looking for, try one of these pages:
41 | 
42 | * :ref:`genindex`
43 | * :ref:`search`
44 | 
45 | 


--------------------------------------------------------------------------------
/docs/intro.rst:
--------------------------------------------------------------------------------
 1 | Getting started
 2 | ===============
 3 | 
 4 | Installation
 5 | ------------
 6 | 
 7 | **rebootpy requires Python 3.5 or higher**
 8 | 
 9 | **Windows**
10 | 
11 | .. code:: sh
12 | 
13 |     py -3 -m pip install rebootpy
14 | 
15 | **Linux**
16 | 
17 | .. code:: sh
18 | 
19 |     python3 -m pip install rebootpy
20 | 
21 | Authentication
22 | --------------
23 | 
24 | To get a bot running, you must use one of several :ref:`authentication methods <authentication>`. If you do not know which one to use, you should stick with :class:`AdvancedAuth` which is used in most examples. :class:`AdvancedAuth` by default will prompt you to login via device code on the Epic Games website upon the bots initial launch. When the bot has successfully authenticated, it will automatically generate credentials which can be used at a later point. That means you can launch your bot without any extra stuff needed after its first launch.
25 | 
26 | Basic example
27 | -------------
28 | 
29 | .. code-block:: python3
30 | 
31 |     import rebootpy
32 |     import json
33 |     import os
34 | 
35 |     filename = 'device_auths.json'
36 | 
37 | 
38 |     class MyClient(rebootpy.Client):
39 |         def __init__(self):
40 |             device_auth_details = self.get_device_auth_details()
41 |             # this auth instance will login via device auth if its present but if its
42 |             # not, it'll open device code in the browser for you to input email & pass
43 |             super().__init__(
44 |                 auth=rebootpy.AdvancedAuth(
45 |                     prompt_device_code=True,
46 |                     **device_auth_details
47 |                 )
48 |             )
49 | 
50 |         def get_device_auth_details(self):
51 |             if os.path.isfile(filename):
52 |                 with open(filename, 'r') as fp:
53 |                     return json.load(fp)
54 |             return {}
55 | 
56 |         def store_device_auth_details(self, details):
57 |             with open(filename, 'w') as fp:
58 |                 json.dump(details, fp)
59 | 
60 |         async def event_device_auth_generate(self, details):
61 |             self.store_device_auth_details(details)
62 | 
63 |         async def event_ready(self):
64 |             print(f'Client ready as {self.user.display_name}')
65 | 
66 |         async def event_friend_request(self, request):
67 |             await request.accept()
68 | 
69 |         async def event_friend_message(self, message):
70 |             print(f'{message.author.display_name}: {message.content}')
71 |             await message.reply('Thanks for your message!')
72 | 
73 | 
74 |     bot = MyClient()
75 |     bot.run()
76 | 


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


--------------------------------------------------------------------------------
/docs/localexts/viewcode.py:
--------------------------------------------------------------------------------
  1 | # flake8: noqa
  2 | 
  3 | """
  4 |     sphinx.ext.viewcode
  5 |     ~~~~~~~~~~~~~~~~~~~
  6 |     Add links to module code in Python object descriptions.
  7 |     :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
  8 |     :license: BSD, see LICENSE for details.
  9 | """
 10 | 
 11 | import traceback
 12 | import json
 13 | from typing import Any, Dict, Iterable, Iterator, Set, Tuple
 14 | 
 15 | from docutils import nodes
 16 | from docutils.nodes import Element, Node
 17 | 
 18 | import sphinx
 19 | from sphinx import addnodes
 20 | from sphinx.application import Sphinx
 21 | from sphinx.environment import BuildEnvironment
 22 | from sphinx.locale import _, __
 23 | from sphinx.pycode import ModuleAnalyzer
 24 | from sphinx.util import get_full_modname, logging, status_iterator
 25 | from sphinx.util.nodes import make_refnode
 26 | 
 27 | from importlib import import_module
 28 | 
 29 | 
 30 | logger = logging.getLogger(__name__)
 31 | 
 32 | 
 33 | def get_github_line_link(app, filepath, line1, line2):
 34 |     try:
 35 |         data = app.config._raw_config['context']
 36 |     except KeyError:
 37 |         return None
 38 | 
 39 |     return 'https://github.com/{user}/{repo}/blob/{version}/{filepath}#L{line1}-L{line2}'.format(
 40 |         user=data['github_user'],
 41 |         repo=data['github_repo'],
 42 |         version=data['github_version'],
 43 |         filepath=filepath,
 44 |         line1=line1,
 45 |         line2=line2
 46 |     )
 47 | 
 48 | 
 49 | def _resolve(app, modname, attribute):
 50 |     if modname is None:
 51 |         return None
 52 | 
 53 |     module = import_module(modname)
 54 | 
 55 |     try:
 56 |         value = module
 57 |         for attr in attribute.split('.'):
 58 |             if attr:
 59 |                 value = getattr(value, attr, None)
 60 | 
 61 |         return getattr(value, '__module__', None), getattr(value, '__qualname__', None)
 62 |     except AttributeError:
 63 |         # sphinx.ext.viewcode can't follow class instance attribute
 64 |         # then AttributeError logging output only verbose mode.
 65 |         return None
 66 |     except Exception:
 67 |         # sphinx.ext.viewcode follow python domain directives.
 68 |         # because of that, if there are no real modules exists that specified
 69 |         # by py:function or other directives, viewcode emits a lot of warnings.
 70 |         # It should be displayed only verbose mode.
 71 |         return None
 72 | 
 73 | 
 74 | def doctree_read(app: Sphinx, doctree: Node) -> None:
 75 |     env = app.builder.env
 76 |     if not hasattr(env, '_viewcode_modules'):
 77 |         env._viewcode_modules = {}  # type: ignore
 78 |     if app.builder.name == "singlehtml":
 79 |         return
 80 |     if app.builder.name.startswith("epub") and not env.config.viewcode_enable_epub:
 81 |         return
 82 | 
 83 |     def has_tag(modname: str, fullname: str, docname: str, refname: str) -> bool:
 84 |         entry = env._viewcode_modules.get(modname, None)  # type: ignore
 85 |         if entry is False:
 86 |             return False
 87 | 
 88 |         code_tags = app.emit_firstresult('viewcode-find-source', modname)
 89 |         if code_tags is None:
 90 |             try:
 91 |                 analyzer = ModuleAnalyzer.for_module(modname)
 92 |                 analyzer.find_tags()
 93 |             except Exception:
 94 |                 env._viewcode_modules[modname] = False  # type: ignore
 95 |                 return False
 96 | 
 97 |             code = analyzer.code
 98 |             tags = analyzer.tags
 99 |         else:
100 |             code, tags = code_tags
101 | 
102 |         if entry is None or entry[0] != code:
103 |             entry = code, tags, {}, refname
104 |             env._viewcode_modules[modname] = entry  # type: ignore
105 |         _, tags, used, _ = entry
106 |         if fullname in tags:
107 |             used[fullname] = docname
108 |             return True
109 | 
110 |         return False
111 | 
112 |     for objnode in doctree.traverse(addnodes.desc):
113 |         if objnode.get('domain') != 'py':
114 |             continue
115 |         names = set()  # type: Set[str]
116 |         for signode in objnode:
117 |             if not isinstance(signode, addnodes.desc_signature):
118 |                 continue
119 | 
120 |             modname = signode.get('module')
121 |             fullname = signode.get('fullname')
122 |             ogfullname = fullname
123 |             refname = modname
124 | 
125 |             ret = _resolve(app, modname, fullname)
126 |             if ret:
127 |                 modname, fullname = ret
128 | 
129 |             if not modname:
130 |                 continue
131 |             if not has_tag(modname, fullname, env.docname, refname):
132 |                 continue
133 |             if fullname in names:
134 |                 # only one link per name, please
135 |                 continue
136 | 
137 |             names.add(fullname)
138 |             pagename = '_modules/' + modname.replace('.', '/')
139 | 
140 |             classes = ['viewcode-link', 'source-link']
141 |             if fullname != ogfullname:
142 |                 new = ogfullname.replace('.', '-')
143 |                 if '.' in ogfullname:
144 |                     new = refname + '-' + new
145 |                 else:
146 |                     new = new.lower()
147 | 
148 |                 fullname_class = 'fullname-{}'.format(new)
149 |             else:
150 |                 fullname_class = 'fullname-none'
151 | 
152 |             classes.append(fullname_class)
153 |             inline = nodes.inline('', _('[source]'), classes=classes)
154 |             onlynode = addnodes.only(expr='html')
155 |             onlynode += addnodes.pending_xref('', inline, reftype='viewcode', refdomain='std',
156 |                                               refexplicit=False, reftarget=pagename,
157 |                                               refid=fullname, refdoc=env.docname)
158 |             signode += onlynode
159 | 
160 | 
161 | def env_merge_info(app: Sphinx, env: BuildEnvironment, docnames: Iterable[str],
162 |                    other: BuildEnvironment) -> None:
163 |     if not hasattr(other, '_viewcode_modules'):
164 |         return
165 |     # create a _viewcode_modules dict on the main environment
166 |     if not hasattr(env, '_viewcode_modules'):
167 |         env._viewcode_modules = {}  # type: ignore
168 |     # now merge in the information from the subprocess
169 |     env._viewcode_modules.update(other._viewcode_modules)  # type: ignore
170 | 
171 | 
172 | def missing_reference(app: Sphinx, env: BuildEnvironment, node: Element, contnode: Node
173 |                       ) -> Node:
174 |     # resolve our "viewcode" reference nodes -- they need special treatment
175 |     if node['reftype'] == 'viewcode':
176 |         return make_refnode(app.builder, node['refdoc'], node['reftarget'],
177 |                             node['refid'], contnode)
178 | 
179 |     return None
180 | 
181 | 
182 | def collect_pages(app: Sphinx) -> Iterator[Tuple[str, Dict[str, Any], str]]:
183 |     env = app.builder.env
184 |     if not hasattr(env, '_viewcode_modules'):
185 |         return
186 |     highlighter = app.builder.highlighter  # type: ignore
187 |     urito = app.builder.get_relative_uri
188 | 
189 |     modnames = set(env._viewcode_modules)  # type: ignore
190 |     for modname, entry in status_iterator(
191 |             sorted(env._viewcode_modules.items()),  # type: ignore
192 |             __('highlighting module code... '), "blue",
193 |             len(env._viewcode_modules),  # type: ignore
194 |             app.verbosity, lambda x: x[0]):
195 |         if not entry:
196 |             continue
197 |         code, tags, used, refname = entry
198 | 
199 |         # construct a page name for the highlighted source
200 |         pagename = '_modules/' + modname.replace('.', '/')
201 |         # highlight the source using the builder's highlighter
202 |         if env.config.highlight_language in ('python3', 'default', 'none'):
203 |             lexer = env.config.highlight_language
204 |         else:
205 |             lexer = 'python'
206 | 
207 |         highlighted = highlighter.highlight_block(code, lexer, linenos=False)
208 |         # split the code into lines
209 |         lines = highlighted.splitlines()
210 |         # split off wrap markup from the first line of the actual code
211 |         before, after = lines[0].split('<pre>')
212 |         lines[0:1] = [before + '<pre>', after]
213 | 
214 |         # nothing to do for the last line; it always starts with </pre> anyway
215 |         # now that we have code lines (starting at index 1), insert anchors for
216 |         # the collected tags (HACK: this only works if the tag boundaries are
217 |         # properly nested!)
218 |         maxindex = len(lines) - 1
219 |         for name, (type_, start, end) in tags.items():
220 |             docname = 'api'
221 |             backlink = urito(pagename, docname) + '#' + refname + '.' + name
222 | 
223 |             if name in used:
224 |                 a_elem = '<a class="viewcode-back docs-link" href="{}" style="margin-right: 3px;">{}</a> '.format(backlink, _('[docs]'))
225 |             else:
226 |                 a_elem = ''
227 | 
228 |             file_ = modname.replace('.', '/') + '.py'
229 |             github_line_link = get_github_line_link(app, file_, start, min(end, maxindex))
230 |             if github_line_link is not None:
231 |                 github_a_elem = '<a class="viewcode-back" href="{}">{}</a>'.format(github_line_link, _('[github]'))
232 |             else:
233 |                 github_a_elem = ''
234 | 
235 |             div_elem = '<div class="viewcode-block" id="{}">'.format(name)
236 | 
237 |             lines[start] = div_elem + github_a_elem  + a_elem + lines[start]
238 |             lines[min(end, maxindex)] += '</div>'
239 | 
240 |         # try to find parents (for submodules)
241 |         parents = []
242 |         parent = modname
243 |         while '.' in parent:
244 |             parent = parent.rsplit('.', 1)[0]
245 |             if parent in modnames:
246 |                 parents.append({
247 |                     'link': urito(pagename, '_modules/' +
248 |                                   parent.replace('.', '/')),
249 |                     'title': parent})
250 |         parents.append({'link': urito(pagename, '_modules/index'),
251 |                         'title': _('Module code')})
252 |         parents.reverse()
253 | 
254 |         # putting it all together
255 |         context = {
256 |             'parents': parents,
257 |             'title': modname,
258 |             'body': (_('<h1>Source code for %s</h1>') % modname +
259 |                      '\n'.join(lines)),
260 |         }
261 |         yield (pagename, context, 'page.html')
262 | 
263 |     if not modnames:
264 |         return
265 | 
266 |     html = ['\n']
267 |     # the stack logic is needed for using nested lists for submodules
268 |     stack = ['']
269 |     for modname in sorted(modnames):
270 |         if modname.startswith(stack[-1]):
271 |             stack.append(modname + '.')
272 |             html.append('<ul>')
273 |         else:
274 |             stack.pop()
275 |             while not modname.startswith(stack[-1]):
276 |                 stack.pop()
277 |                 html.append('</ul>')
278 |             stack.append(modname + '.')
279 |         html.append('<li><a href="%s">%s</a></li>\n' % (
280 |             urito('_modules/index', '_modules/' + modname.replace('.', '/')),
281 |             modname))
282 |     html.append('</ul>' * (len(stack) - 1))
283 |     context = {
284 |         'title': _('Overview: module code'),
285 |         'body': (_('<h1>All modules for which code is available</h1>') +
286 |                  ''.join(html)),
287 |     }
288 | 
289 |     yield ('_modules/index', context, 'page.html')
290 | 
291 | 
292 | def setup(app: Sphinx) -> Dict[str, Any]:
293 |     app.add_config_value('viewcode_import', None, False)
294 |     app.add_config_value('viewcode_enable_epub', False, False)
295 |     app.add_config_value('viewcode_follow_imported_members', True, False)
296 |     app.connect('doctree-read', doctree_read)
297 |     app.connect('env-merge-info', env_merge_info)
298 |     app.connect('html-collect-pages', collect_pages)
299 |     app.connect('missing-reference', missing_reference)
300 |     # app.add_config_value('viewcode_include_modules', [], 'env')
301 |     # app.add_config_value('viewcode_exclude_modules', [], 'env')
302 |     app.add_event('viewcode-find-source')
303 |     app.add_event('viewcode-follow-imported')
304 |     print('Loaded custom viewcode.')
305 |     return {
306 |         'version': sphinx.__display_version__,
307 |         'env_version': 1,
308 |         'parallel_read_safe': True
309 |     }
310 | 


--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
  1 | @ECHO OFF
  2 | 
  3 | REM Command file for Sphinx documentation
  4 | 
  5 | if "%SPHINXBUILD%" == "" (
  6 | 	set SPHINXBUILD=sphinx3-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=python3.7 -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


--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | sphinxcontrib-trio==1.1.2
2 | furo==2021.4.11b34
3 | Jinja2<3.1
4 | aiohttp>=3.3
5 | aioxmpp>=0.13.2
6 | aioconsole>=0.1.15
7 | 


--------------------------------------------------------------------------------
/docs/resources/images/authorization_code.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xMistt/rebootpy/dfecf9922cb874c432c2d756d444f40f47d7fc8a/docs/resources/images/authorization_code.png


--------------------------------------------------------------------------------
/docs/usedby.rst:
--------------------------------------------------------------------------------
 1 | .. currentmodule:: rebootpy
 2 | 
 3 | Who uses fortnitepy?
 4 | ====================
 5 | 
 6 | Yunite
 7 | ------
 8 | 
 9 | .. image:: https://yunite.xyz/img/android-chrome-384x384.png
10 |    :target: https://yunite.xyz
11 |    :height: 100
12 | 
13 | Yunite is a multipurpose discord bot that offers features like safe custom game registration, self organized tournaments with accurate placings and more.
14 | 
15 | 
16 | Rematch.gg
17 | ----------
18 | 
19 | .. image:: https://rematch.gg/assets/img/logo/rematch-full-new.png
20 |    :target: https://rematch.gg
21 |    :height: 100
22 | 
23 | Rematch.gg is a platform that hosts fortnite scrims for cash prizes as well as offer a place for people to connect and play tournaments, zone wars, box fights and more.
24 | 
25 | 
26 | PartyBot
27 | --------
28 | 
29 | .. image:: https://partybot.net/cdn/skull.png
30 |    :target: https://github.com/xmistt/fortnitepy-bot
31 |    :height: 100
32 | 
33 | PartyBot is a self hosted so called lobby bot that you can mess around with in a party. You can use it to showcase rare outfits and other cosmetics.
34 | 
35 | 
36 | EasyFortniteStats
37 | -----------------
38 | 
39 | .. image:: https://gblobscdn.gitbook.com/spaces%2F-LjpXsmo7aeUKmSF7KVz%2Favatar-1612982571858.png?alt=media
40 |    :target: https://www.easyfnstats.com
41 |    :height: 100
42 | 
43 | EasyFortniteStats is a discord bot built around fortnite stats and news. It features graphical stats, item shop, ingame radio and more.


--------------------------------------------------------------------------------
/examples/basic_bot.py:
--------------------------------------------------------------------------------
 1 | """This example showcases how to use rebootpy.
 2 | 
 3 | NOTE: This example uses AdvancedAuth and stores the details in a file.
 4 | It is important that this file is moved whenever the script itself is moved
 5 | because it relies on the stored details. However, if the file is nowhere to
 6 | be found, it will simply use device code to generate a new file.
 7 | """
 8 | 
 9 | import rebootpy
10 | import json
11 | import os
12 | 
13 | from rebootpy.ext import commands
14 | 
15 | filename = 'device_auths.json'
16 | 
17 | 
18 | def get_device_auth_details():
19 |     if os.path.isfile(filename):
20 |         with open(filename, 'r') as fp:
21 |             return json.load(fp)
22 |     return {}
23 | 
24 | 
25 | def store_device_auth_details(details):
26 |     with open(filename, 'w') as fp:
27 |         json.dump(details, fp)
28 | 
29 | 
30 | device_auth_details = get_device_auth_details()
31 | bot = commands.Bot(
32 |     command_prefix='!',
33 |     auth=rebootpy.AdvancedAuth(
34 |         prompt_device_code=True,
35 |         open_link_in_browser=True,
36 |         **device_auth_details
37 |     )
38 | )
39 | 
40 | 
41 | @bot.event
42 | async def event_device_auth_generate(details):
43 |     store_device_auth_details(details)
44 | 
45 | 
46 | @bot.event
47 | async def event_ready():
48 |     print(f'Bot ready as {bot.user.display_name} ({bot.user.id}).')
49 | 
50 | 
51 | @bot.event
52 | async def event_friend_request(request):
53 |     await request.accept()
54 | 
55 | 
56 | @bot.command()
57 | async def hello(ctx):
58 |     await ctx.send('Hello!')
59 | 
60 | 
61 | bot.run()
62 | 


--------------------------------------------------------------------------------
/examples/discord_integration.py:
--------------------------------------------------------------------------------
  1 | """This example makes use of discord integration with rebootpy.
  2 | 
  3 | NOTE: This example uses AdvancedAuth and stores the details in a file.
  4 | It is important that this file is moved whenever the script itself is moved
  5 | because it relies on the stored details. However, if the file is nowhere to
  6 | be found, it will simply prompt you to enter a new authorization code 
  7 | to generate a new file.
  8 | """
  9 | 
 10 | import rebootpy
 11 | import discord
 12 | import json
 13 | import os
 14 | 
 15 | from rebootpy.ext import commands as fortnite_commands
 16 | from discord.ext import commands as discord_commands
 17 | 
 18 | discord_bot_token = ''  # the discord bots token
 19 | filename = 'device_auths.json'
 20 | description = 'My discord + fortnite bot!'
 21 | 
 22 | 
 23 | def get_device_auth_details():
 24 |     if os.path.isfile(filename):
 25 |         with open(filename, 'r') as fp:
 26 |             return json.load(fp)
 27 |     return {}
 28 | 
 29 | 
 30 | def store_device_auth_details(details):
 31 |     with open(filename, 'w') as fp:
 32 |         json.dump(details, fp)
 33 | 
 34 | 
 35 | device_auth_details = get_device_auth_details()
 36 | fortnite_bot = fortnite_commands.Bot(
 37 |     command_prefix='!',
 38 |     description=description,
 39 |     auth=rebootpy.AdvancedAuth(
 40 |         prompt_authorization_code=True,
 41 |         prompt_device_code=False,
 42 |         **device_auth_details
 43 |     )
 44 | )
 45 | 
 46 | intents = discord.Intents.all()
 47 | discord_bot = discord_commands.Bot(
 48 |     command_prefix='!',
 49 |     description=description,
 50 |     case_insensitive=True,
 51 |     intents=intents
 52 | )
 53 | 
 54 | 
 55 | @fortnite_bot.event
 56 | async def event_ready():
 57 |     print('Fortnite bot ready')
 58 |     await discord_bot.start(discord_bot_token)
 59 | 
 60 | 
 61 | @fortnite_bot.event
 62 | async def event_device_auth_generate(details):
 63 |     store_device_auth_details(details)
 64 | 
 65 | 
 66 | @fortnite_bot.event
 67 | async def event_before_close():
 68 |     await discord_bot.close()
 69 | 
 70 | 
 71 | @discord_bot.event
 72 | async def on_ready():
 73 |     print('Discord bot ready')
 74 | 
 75 | 
 76 | @discord_bot.event
 77 | async def on_message(message):
 78 |     if message.author.bot:
 79 |         return
 80 | 
 81 |     print('Received discord message from {0.author.display_name} | Content "{0.content}"'.format(message))
 82 |     await discord_bot.process_commands(message)
 83 | 
 84 | 
 85 | @fortnite_bot.event
 86 | async def event_friend_message(message):
 87 |     print('Received fortnite message from {0.author.display_name} | Content "{0.content}"'.format(message))
 88 | 
 89 | 
 90 | # discord command
 91 | @discord_bot.command()
 92 | async def mydiscordcommand(ctx):
 93 |     await ctx.send('Hello there discord!')
 94 | 
 95 | 
 96 | @fortnite_bot.command()
 97 | async def myfortnitecommand(ctx):
 98 |     await ctx.send('Hello there fortnite!')
 99 | 
100 | 
101 | fortnite_bot.run()
102 | 


--------------------------------------------------------------------------------
/examples/fortnite_api_path.py:
--------------------------------------------------------------------------------
 1 | """This example showcases how to use rebootpy integrating with an api
 2 | in order to correctly get the path for cosmetics other than outfits.
 3 | 
 4 | NOTE: This example uses AdvancedAuth and stores the details in a file.
 5 | It is important that this file is moved whenever the script itself is moved
 6 | because it relies on the stored details. However, if the file is nowhere to
 7 | be found, it will simply use device code to generate a new file.
 8 | """
 9 | 
10 | import rebootpy
11 | import json
12 | import os
13 | import aiohttp
14 | 
15 | from rebootpy.ext import commands
16 | 
17 | filename = 'device_auths.json'
18 | 
19 | 
20 | def get_device_auth_details():
21 |     if os.path.isfile(filename):
22 |         with open(filename, 'r') as fp:
23 |             return json.load(fp)
24 |     return {}
25 | 
26 | 
27 | def store_device_auth_details(details):
28 |     with open(filename, 'w') as fp:
29 |         json.dump(details, fp)
30 | 
31 | 
32 | device_auth_details = get_device_auth_details()
33 | bot = commands.Bot(
34 |     command_prefix='!',
35 |     auth=rebootpy.AdvancedAuth(
36 |         prompt_device_code=True,
37 |         open_link_in_browser=True,
38 |         **device_auth_details
39 |     )
40 | )
41 | 
42 | 
43 | @bot.event
44 | async def event_device_auth_generate(details):
45 |     store_device_auth_details(details)
46 | 
47 | 
48 | @bot.event
49 | async def event_ready():
50 |     print(f'Bot ready as {bot.user.display_name} ({bot.user.id}).')
51 | 
52 | 
53 | @bot.event
54 | async def event_friend_request(request):
55 |     await request.accept()
56 | 
57 | 
58 | @bot.event
59 | async def event_party_invite(invite):
60 |     await invite.accept()
61 | 
62 | 
63 | @bot.command()
64 | async def emote(ctx, *, search: str):
65 |     async with aiohttp.ClientSession() as session:
66 |         async with session.request(
67 |             method="GET",
68 |             url="https://fortnite-api.com/v2/cosmetics/br/search?name=" \
69 |             f"{search}&matchMethod=contains&backendType=AthenaDance"
70 |         ) as request:
71 |             if request.status == 404:
72 |                 return await ctx.send('Dance not found!')
73 | 
74 |             data = await request.json()
75 | 
76 |     if "brcosmetics" in data['data']['path'].lower():
77 |         await bot.party.me.set_emote(asset=data['data']['id'])
78 |     else:
79 |         path = f"/Game/Athena/Items/Cosmetics/Dances/{data['data']['id']}.{data['data']['id']}"
80 |         await bot.party.me.set_emote(asset=path)
81 | 
82 | 
83 | bot.run()
84 | 


--------------------------------------------------------------------------------
/examples/multiple_clients.py:
--------------------------------------------------------------------------------
 1 | """This example makes use of multiple accounts.
 2 | 
 3 | NOTE: This example uses AdvancedAuth and stores the details in a file.
 4 | It is important that this file is moved whenever the script itself is moved
 5 | because it relies on the stored details. However, if the file is nowhere to
 6 | be found, it will simply use device code to generate a new file.
 7 | """
 8 | 
 9 | import rebootpy
10 | import asyncio
11 | import functools
12 | import os
13 | import json
14 | 
15 | instances = {}
16 | filename = 'device_auths.json'
17 | 
18 | def get_device_auth_details():
19 |     with open(filename, 'r') as fp:
20 |         return json.load(fp)
21 | 
22 | async def event_sub_ready(client):
23 |     instances[client.user.id] = client
24 |     print(f'Bot ready as {client.user.display_name} ({client.user.id}).')
25 | 
26 | async def event_sub_friend_request(request):
27 |     print('{0.client.user.display_name} received a friend request.'.format(request))
28 |     await request.accept()
29 | 
30 | async def event_sub_party_member_join(member):
31 |     print("{0.display_name} joined {0.client.user.display_name}'s party.".format(member))
32 | 
33 | clients = []
34 | device_auths = get_device_auth_details()
35 | for account, device_auth in device_auths.items():
36 |     client = rebootpy.Client(
37 |         auth=rebootpy.DeviceAuth(
38 |             **device_auth
39 |         ),
40 |         default_party_member_config=rebootpy.DefaultPartyMemberConfig(
41 |             meta=(
42 |                 functools.partial(rebootpy.ClientPartyMember.set_outfit, 'CID_175_Athena_Commando_M_Celestial'), # galaxy skin
43 |             )
44 |         )
45 |     )
46 | 
47 |     # register events here
48 |     client.add_event_handler('friend_request', event_sub_friend_request)
49 |     client.add_event_handler('party_member_join', event_sub_party_member_join)
50 | 
51 |     clients.append(client)
52 | 
53 | rebootpy.run_multiple(
54 |     clients,
55 |     ready_callback=event_sub_ready,
56 |     all_ready_callback=lambda: print('All clients ready')
57 | )
58 | 


--------------------------------------------------------------------------------
/examples/sanic_integration.py:
--------------------------------------------------------------------------------
 1 | """This example showcases how to use rebootpy with the asynchronous
 2 | web framework sanic.
 3 | """
 4 | 
 5 | import rebootpy
 6 | import json
 7 | import os
 8 | import sanic
 9 | 
10 | from rebootpy.ext import commands
11 | 
12 | 
13 | filename = 'device_auths.json'
14 | description = 'My awesome fortnite bot / sanic app!'
15 | 
16 | 
17 | def get_device_auth_details():
18 |     with open(filename, 'r') as fp:
19 |         return json.load(fp)
20 | 
21 | 
22 | device_auths = get_device_auth_details()
23 | bot = commands.Bot(
24 |     command_prefix='!',
25 |     auth=rebootpy.DeviceAuth(
26 |         **device_auths
27 |     )
28 | )
29 | 
30 | sanic_app = sanic.Sanic(__name__)
31 | server = None
32 | 
33 | 
34 | @bot.event
35 | async def event_device_auth_generate(details, email):
36 |     store_device_auth_details(email, details)
37 | 
38 | 
39 | @sanic_app.route('/friends', methods=['GET'])
40 | async def get_friends_handler(request):
41 |     friends = [friend.id for friend in bot.friends]
42 |     return sanic.response.json(friends)
43 | 
44 | 
45 | @bot.event
46 | async def event_ready():
47 |     global server
48 | 
49 |     print(f'Bot ready as {bot.user.display_name} ({bot.user.id}).')
50 | 
51 |     server = await sanic_app.create_server(
52 |         port=80, host="0.0.0.0", return_asyncio_server=True
53 |     )
54 | 
55 |     await server.startup()
56 |     await server.serve_forever()
57 | 
58 | 
59 | @bot.event
60 | async def event_before_close():
61 |     global server
62 | 
63 |     if server is not None:
64 |         await server.close()
65 | 
66 | 
67 | @bot.event
68 | async def event_friend_request(request):
69 |     await request.accept()
70 | 
71 | 
72 | @bot.command()
73 | async def hello(ctx):
74 |     await ctx.send('Hello!')
75 | 
76 | 
77 | bot.run()
78 | 


--------------------------------------------------------------------------------
/examples/subclass_client.py:
--------------------------------------------------------------------------------
 1 | """This example showcases how to use rebootpy within a subclass. If captcha
 2 | is enforced for the accounts, you will only have to enter the authorization code
 3 | the first time you run this script.
 4 | 
 5 | NOTE: This example uses AdvancedAuth and stores the details in a file.
 6 | It is important that this file is moved whenever the script itself is moved
 7 | because it relies on the stored details. However, if the file is nowhere to
 8 | be found, it will simply use device code to generate a new file.
 9 | """
10 | 
11 | import rebootpy
12 | import json
13 | import os
14 | 
15 | from rebootpy.ext import commands
16 | 
17 | 
18 | filename = 'device_auths.json'
19 | description = 'My awesome fortnite bot!'
20 | 
21 | 
22 | def get_device_auth_details():
23 |     if os.path.isfile(filename):
24 |         with open(filename, 'r') as fp:
25 |             return json.load(fp)
26 |     return {}
27 | 
28 | 
29 | def store_device_auth_details(details):
30 |     with open(filename, 'w') as fp:
31 |         json.dump(details, fp)
32 | 
33 | 
34 | class MyBot(commands.Bot):
35 |     def __init__(self):
36 |         device_auth_details = get_device_auth_details()
37 |         super().__init__(
38 |             command_prefix='!',
39 |             description=description,
40 |             auth=rebootpy.AdvancedAuth(
41 |                 prompt_device_code=True,
42 |                 open_link_in_browser=True,
43 |                 **device_auth_details
44 |             )
45 |         )
46 | 
47 |     async def event_device_auth_generate(self, details):
48 |         store_device_auth_details(details)
49 | 
50 |     async def event_ready(self):
51 |         print(f'Bot ready as {bot.user.display_name} ({bot.user.id}).')
52 | 
53 |     async def event_friend_request(self, request):
54 |         await request.accept()
55 | 
56 |     async def event_friend_message(self, message):
57 |         print('Received message from {0.author.display_name} | Content: "{0.content}"'.format(message))
58 |         await message.reply('Thanks for your message!')
59 | 
60 |     @commands.command()
61 |     async def hello(self, ctx):
62 |         await ctx.send('Hello there!')
63 | 
64 | 
65 | bot = MyBot()
66 | bot.run()
67 | 


--------------------------------------------------------------------------------
/rebootpy/__init__.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | # flake8: noqa
 3 | 
 4 | """
 5 | MIT License
 6 | 
 7 | Copyright (c) 2019-2021 Terbau
 8 | 
 9 | Permission is hereby granted, free of charge, to any person obtaining a copy
10 | of this software and associated documentation files (the "Software"), to deal
11 | in the Software without restriction, including without limitation the rights
12 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 | copies of the Software, and to permit persons to whom the Software is
14 | furnished to do so, subject to the following conditions:
15 | 
16 | The above copyright notice and this permission notice shall be included in all
17 | copies or substantial portions of the Software.
18 | 
19 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 | SOFTWARE.
26 | """
27 | 
28 | __version__ = '0.9.5'
29 | 
30 | from .client import (BasicClient, Client, run_multiple, start_multiple,
31 |                      close_multiple)
32 | from .auth import (Auth, DeviceCodeAuth, ExchangeCodeAuth,
33 |                    AuthorizationCodeAuth, DeviceAuth, RefreshTokenAuth,
34 |                    AdvancedAuth)
35 | from .friend import Friend, IncomingPendingFriend, OutgoingPendingFriend
36 | from .message import FriendMessage, PartyMessage
37 | from .party import (DefaultPartyConfig, DefaultPartyMemberConfig, PartyMember,
38 |                     ClientPartyMember, Party,  ClientParty,
39 |                     ReceivedPartyInvitation, SentPartyInvitation,
40 |                     PartyJoinConfirmation, PartyJoinRequest, SquadAssignment,
41 |                     PlaylistRequest)
42 | from .presence import Presence, PresenceGameplayStats, PresenceParty
43 | from .user import (ClientUser, User, BlockedUser, ExternalAuth,
44 |                    UserSearchEntry, SacSearchEntryUser)
45 | from .stats import StatsV2, StatsCollection, CompetitiveRank
46 | from .enums import *
47 | from .errors import *
48 | from .store import Store, StoreItem
49 | from. creative import CreativeIsland, CreativeIslandRating
50 | from .news import BattleRoyaleNewsPost
51 | from .playlist import Playlist
52 | from .avatar import Avatar
53 | from .http import HTTPRetryConfig, Route
54 | from .utils import *
55 | 


--------------------------------------------------------------------------------
/rebootpy/avatar.py:
--------------------------------------------------------------------------------
 1 | from typing import Dict, Optional
 2 | 
 3 | 
 4 | class Avatar:
 5 |     """Represents a friend's avatar. This is always related to the outfit
 6 |     the friend has equipped."""
 7 | 
 8 |     __slots__ = ('_namespace', '_asset_type', '_asset')
 9 | 
10 |     def __init__(self, data: Dict[str, str]) -> None:
11 |         self._namespace = data['namespace']
12 | 
13 |         avatar_id = data['avatarId']
14 |         if avatar_id:
15 |             split = avatar_id.split(':')
16 |             self._asset_type = split[0]
17 |             self._asset = split[1]
18 |         else:
19 |             self._asset_type = None
20 |             self._asset = None
21 | 
22 |     def __repr__(self) -> str:
23 |         return ('<Avatar asset={0.asset!r} '
24 |                 'asset_type={0.asset_type!r}>'.format(self))
25 | 
26 |     def __eq__(self, other) -> bool:
27 |         return isinstance(other, Avatar) and \
28 |             other.namespace == self.namespace and \
29 |             other.asset_type == self.asset_type and \
30 |             other.asset == self.asset
31 | 
32 |     def __ne__(self, other) -> bool:
33 |         return not self.__eq__(other)
34 | 
35 |     @property
36 |     def namespace(self) -> str:
37 |         """:class:`str`: The namespace of the avatar."""
38 |         return self._namespace
39 | 
40 |     @property
41 |     def asset_type(self) -> Optional[str]:
42 |         """Optional[:class:`str`]: The asset type. This is usually ``ATHENACHARACTER``
43 |         If the friend has no avatar set, or has a default character set,
44 |         then this will be ``None``.
45 |         """
46 |         return self._asset_type
47 | 
48 |     @property
49 |     def asset(self) -> Optional[str]:
50 |         """Optional[:class:`str`]: The asset of the avatar. This is usually a
51 |         CID in full caps. If the friend has no avatar set, or has a default
52 |         character set, then this will be ``None``.
53 |         """
54 |         return self._asset
55 | 


--------------------------------------------------------------------------------
/rebootpy/creative.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2024 Oli
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | import re
 28 | import datetime
 29 | import json
 30 | 
 31 | from typing import TYPE_CHECKING, Optional, List
 32 | 
 33 | from .utils import from_iso
 34 | 
 35 | if TYPE_CHECKING:
 36 |     from .client import Client
 37 | 
 38 | 
 39 | class CreativeIslandRating:
 40 |     """Creative island rating."""
 41 |     def __init__(self, board: str, data: dict) -> None:
 42 |         self._board = board
 43 |         self._descriptors = data['descriptors']
 44 |         self._rating_overridden = data['rating_overridden']
 45 |         self._rating = data['rating']
 46 |         self._initial_rating = data['initial_rating']
 47 |         self._interactive_elements = data['interactive_elements']
 48 | 
 49 |         self._raw = data
 50 | 
 51 |     def __str__(self) -> str:
 52 |         return self._rating
 53 | 
 54 |     def __repr__(self) -> str:
 55 |         return f'<CreativeIslandRating board={self.board!r} ' \
 56 |                f'rating={self.rating!r}>'
 57 | 
 58 |     @property
 59 |     def board(self) -> str:
 60 |         """:class:`str`: The name of the board of which the rating is from."""
 61 |         return self._board
 62 | 
 63 |     @property
 64 |     def descriptors(self) -> str:
 65 |         """:class:`str`: Rating descriptors of the island."""
 66 |         return self._descriptors
 67 | 
 68 |     @property
 69 |     def rating(self) -> str:
 70 |         """:class:`str`: The rating of the island."""
 71 |         return self._rating
 72 | 
 73 |     @property
 74 |     def initial_rating(self) -> str:
 75 |         """:class:`str`: The initial rating of the island."""
 76 |         return self._initial_rating
 77 | 
 78 |     @property
 79 |     def interactive_elements(self) -> str:
 80 |         """:class:`str`: Interactive elements of the island."""
 81 |         return self._interactive_elements
 82 | 
 83 | 
 84 | class CreativeIsland:
 85 |     """Creative island."""
 86 |     def __init__(self, client: 'Client', data: dict) -> None:
 87 |         self.client = client
 88 | 
 89 |         self._creator_name = data['creatorName']
 90 |         self._creator_account_id = data['accountId']
 91 |         self._mnemonic = data['mnemonic']
 92 |         self._name = data['metadata']['title']
 93 |         self._image_url = data['metadata']['image_url']
 94 |         self._version = data['version']
 95 |         self._active = data['active']
 96 |         self._created = from_iso(data['created'])
 97 |         self._published = from_iso(data['published'])
 98 |         self._description_tags = data['descriptionTags']
 99 |         self._type = data['linkType']
100 |         self._lobby_background_image = data['metadata'].get(
101 |             'lobby_background_image_urls', {'url': None}
102 |         )['url']
103 |         self._creator_sac_slug = data['metadata'].get('support_code')
104 |         self._tagline = data['metadata'].get('tagline')
105 |         self._ratings = data['metadata'].get('ratings', {"boards": {}})
106 | 
107 |         self._raw = data
108 | 
109 |     def __str__(self) -> str:
110 |         return self._title
111 | 
112 |     def __repr__(self) -> str:
113 |         return f'<CreativeIsland name={self.name!r} mnemonic={self.mnemonic!r}>'
114 | 
115 |     @property
116 |     def creator_name(self) -> str:
117 |         """:class:`str`: The name of the island creator."""
118 |         return self._creator_name
119 | 
120 |     @property
121 |     def creator_account_id(self) -> str:
122 |         """:class:`str`: The account id of the island creator."""
123 |         return self._creator_account_id
124 | 
125 |     @property
126 |     def mnemonic(self) -> str:
127 |         """:class:`str`: The mnemonic of the island, either being island code or playlist id."""
128 |         return self._mnemonic
129 | 
130 |     @property
131 |     def name(self) -> str:
132 |         """:class:`str`: The name of the island."""
133 |         return self._name
134 | 
135 |     @property
136 |     def image_url(self) -> str:
137 |         """:class:`str`: The image URL of the island."""
138 |         return self._image_url
139 | 
140 |     @property
141 |     def version(self) -> int:
142 |         """:class:`int`: The current iteration of the island."""
143 |         return self._version
144 | 
145 |     @property
146 |     def active(self) -> bool:
147 |         """:class:`bool`: Whether or not the island is active."""
148 |         return self._active
149 | 
150 |     @property
151 |     def created(self) -> datetime.datetime:
152 |         """:class:`datetime.datetime`: The UTC time the island was created."""
153 |         return self._created
154 | 
155 |     @property
156 |     def published(self) -> datetime.datetime:
157 |         """:class:`datetime.datetime`: The UTC time the island was published."""
158 |         return self._published
159 | 
160 |     @property
161 |     def description_tags(self) -> list:
162 |         """:class:`list`: List of description tags."""
163 |         return self._description_tags
164 | 
165 |     @property
166 |     def lobby_background_image(self) -> str:
167 |         """:class:`str`: The image URL of the lobby background, if none Fortnite will use the default."""
168 |         return self._lobby_background_image
169 | 
170 |     @property
171 |     def creator_sac_slug(self) -> str:
172 |         """:class:`str`: The Support-a-Creator slug of the island creator."""
173 |         return self._creator_sac_slug
174 | 
175 |     @property
176 |     def tagline(self) -> str:
177 |         """:class:`str`: The tagline of the island."""
178 |         return self._tagline
179 | 
180 |     @property
181 |     def ratings(self) -> List[CreativeIslandRating]:
182 |         """List[:class:`CreativeIslandRating`]: A list containing data about
183 |         all age ratings for the island.
184 |         """
185 |         return [CreativeIslandRating(board=board, data=data) for board, data in self._ratings['boards'].items()]
186 | 
187 |     @property
188 |     def is_creative_island(self) -> bool:
189 |         """:class:`bool`: Returns ``True`` if the island is a creative map,
190 |         ``False`` if it is a playlist."""
191 |         return self._type in ('valkyrie:application', 'Creative:Island')
192 | 


--------------------------------------------------------------------------------
/rebootpy/errors.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2019-2021 Terbau
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | from aiohttp import ClientResponse
 28 | from typing import Union, TYPE_CHECKING
 29 | 
 30 | if TYPE_CHECKING:
 31 |     from .http import Route  # noqa
 32 | 
 33 | 
 34 | class FortniteException(Exception):
 35 |     """Base exception for rebootpy.
 36 | 
 37 |     This could in theory be caught to handle all exceptions thrown by this
 38 |     library.
 39 |     """
 40 |     pass
 41 | 
 42 | 
 43 | class AuthException(FortniteException):
 44 |     """This exception is raised when auth fails by invalid credentials
 45 |     passed or some other misc failure.
 46 | 
 47 |     Attributes
 48 |     ----------
 49 |     original: :exc:`FortniteException`
 50 |         The original exception raised. The original error always inherits from
 51 |         :exc:`FortniteException`.
 52 |     """
 53 |     def __init__(self, message: str, original: Exception) -> None:
 54 |         super().__init__(message)
 55 |         self.original = original
 56 | 
 57 | 
 58 | class EventError(FortniteException):
 59 |     """This exception is raised when something regarding events fails."""
 60 |     pass
 61 | 
 62 | 
 63 | class XMPPError(FortniteException):
 64 |     """This exception is raised when something regarding the XMPP service
 65 |     fails.
 66 |     """
 67 |     pass
 68 | 
 69 | 
 70 | class PartyError(FortniteException):
 71 |     """This exception is raised when something regarding parties fails."""
 72 |     pass
 73 | 
 74 | 
 75 | class PartyIsFull(FortniteException):
 76 |     """This exception is raised when the bot attempts to join a full party."""
 77 | 
 78 | 
 79 | class Forbidden(FortniteException):
 80 |     """This exception is raised whenever you attempted a request that your
 81 |     account does not have permission to do.
 82 |     """
 83 |     pass
 84 | 
 85 | 
 86 | class NotFound(FortniteException):
 87 |     """This exception is raised when something was not found by fortnites
 88 |     services.
 89 |     """
 90 |     pass
 91 | 
 92 | 
 93 | class NoMoreItems(FortniteException):
 94 |     """This exception is raised whenever an iterator does not have any more
 95 |     items.
 96 |     """
 97 |     pass
 98 | 
 99 | 
100 | class DuplicateFriendship(FortniteException):
101 |     """This exception is raised whenever the client attempts to add a user as
102 |     friend when the friendship already exists."""
103 |     pass
104 | 
105 | 
106 | class FriendshipRequestAlreadySent(FortniteException):
107 |     """This exception is raised whenever the client attempts to send a friend
108 |     request to a user that has already received a friend request from the
109 |     client.
110 |     """
111 |     pass
112 | 
113 | 
114 | class MaxFriendshipsExceeded(FortniteException):
115 |     """This excepttion is raised if the client has hit the limit for
116 |     friendships.
117 |     """
118 |     pass
119 | 
120 | 
121 | class InviteeMaxFriendshipsExceeded(FortniteException):
122 |     """This exception is raised if the user you attempted to add has
123 |     hit the limit for friendships.
124 |     """
125 |     pass
126 | 
127 | 
128 | class InviteeMaxFriendshipRequestsExceeded(FortniteException):
129 |     """This exception is raised if the user you attempted to add has
130 |     hit the limit for the amount of friendship requests a user can have
131 |     at a time.
132 |     """
133 |     pass
134 | 
135 | 
136 | class FriendOffline(FortniteException):
137 |     """This exception is raised when an action that requires a friend to be
138 |     online is performed at an offline friend.
139 |     """
140 |     pass
141 | 
142 | 
143 | class InvalidOffer(FortniteException):
144 |     """This exception is raised when an invalid/outdated offer is
145 |     passed. Only offers currently in the item shop are valid."""
146 |     pass
147 | 
148 | 
149 | class ChatError(FortniteException):
150 |     """This exception is raised whenever there is an issue with
151 |     the chat service i.e. message too long, client attempts to
152 |     send a message into an empty party, etc."""
153 |     pass
154 | 
155 | 
156 | class ValidationFailure(FortniteException):
157 |     """Represents a validation failure returned.
158 | 
159 |     Attributes
160 |     ----------
161 |     field_name: :class:`str`
162 |         Name of the field that was invalid.
163 |     invalid_value: :class:`str`
164 |         The invalid value.
165 |     message: :class:`str`
166 |         The message explaining why the field value was invalid.
167 |     message_code: :class:`str`
168 |         The raw error message code received.
169 |     message_vars: Dict[:class:`str`, :class:`str`]
170 |         The message variables received.
171 |     """
172 | 
173 |     def __init__(self, data: dict) -> None:
174 |         self.field_name = data['fieldName']
175 |         self.invalid_value = data.get('invalidValue')
176 |         self.message = data['errorMessage']
177 |         self.message_code = data['errorCode']
178 |         self.message_vars = data['messageVars']
179 | 
180 | 
181 | class HTTPException(FortniteException):
182 |     """This exception is raised when an error is received by Fortnite services.
183 | 
184 |     Attributes
185 |     ----------
186 |     response: :class:`aiohttp.ClientResponse`
187 |         The response from the HTTP request.
188 |     text: :class:`str`
189 |         The error message.
190 |     status: :class:`int`
191 |         The status code of the HTTP request.
192 |     route: Union[:class:`Route`, :class:`str`]
193 |         The route or url used for this request.
194 |     raw: Union[:class:`str`, :class:`dict`]
195 |         The raw message/data received from Fortnite services.
196 |     request_headers: :class:`dict`
197 |         The headers used for the request.
198 |     message: :class:`str`
199 |         The raw error message received from Fortnite services.
200 |     message_code: Optional[:class:`str`]
201 |         The raw error message code received from Fortnite services.
202 |     message_vars: List[:class:`str`]
203 |         List containing arguments passed to the message.
204 |     code: Optional[:class:`int`]
205 |         The error code received from Fortnite services.
206 |     originating_service: Optional[:class:`str`]
207 |         The originating service this error was received from.
208 |     intent: Optional[:class:`str`]
209 |         The prod this error was received from.
210 |     validation_failures: Optional[List[:exc:`ValidationFailure`]]
211 |         A list containing information about the validation failures.
212 |         ``None`` if the error was not raised a validation issue.
213 |     """
214 | 
215 |     def __init__(self, response: ClientResponse,
216 |                  route: Union['Route', str],
217 |                  message: dict,
218 |                  request_headers: dict) -> None:
219 |         self.response = response
220 |         self.status = response.status
221 |         self.route = route
222 |         self.raw = message
223 |         self.request_headers = request_headers
224 | 
225 |         _err = message if isinstance(message, dict) else {}
226 |         self.message = _err.get('errorMessage')
227 |         self.message_code = _err.get('errorCode')
228 |         self.message_vars = _err.get('messageVars', [])
229 |         self.code = _err.get('numericErrorCode')
230 |         self.originating_service = _err.get('originatingService')
231 |         self.intent = _err.get('intent')
232 | 
233 |         validation_failures_data = _err.get('validationFailures')
234 |         if validation_failures_data is not None:
235 |             self.validation_failures = [
236 |                 ValidationFailure(d) for d in validation_failures_data.values()
237 |             ]
238 |         else:
239 |             self.validation_failures = None
240 | 
241 |         if self.message_code is not None:
242 |             fmt = self.message
243 |         else:
244 |             fmt = '{0} - {1}'.format(self.status, self.message)
245 | 
246 |         self.text = 'Code: "{0}" - {1}'.format(
247 |             self.message_code,
248 |             fmt
249 |         )
250 | 
251 |         super().__init__(self.text)
252 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/__init__.py:
--------------------------------------------------------------------------------
 1 | # flake8: noqa
 2 | 
 3 | from .bot import Bot
 4 | from .context import Context
 5 | from .core import *
 6 | from .errors import *
 7 | from .converter import *
 8 | from .cog import *
 9 | from .cooldown import *
10 | from .help import *


--------------------------------------------------------------------------------
/rebootpy/ext/commands/_types.py:
--------------------------------------------------------------------------------
 1 | """
 2 | The MIT License (MIT)
 3 | 
 4 | Copyright (c) 2015-present Rapptz
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a
 7 | copy of this software and associated documentation files (the "Software"),
 8 | to deal in the Software without restriction, including without limitation
 9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 | and/or sell copies of the Software, and to permit persons to whom the
11 | Software is furnished to do so, subject to the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be included in
14 | all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 | OR 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
21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 | DEALINGS IN THE SOFTWARE.
23 | """
24 | 
25 | 
26 | class _BaseCommand:
27 |     __slots__ = ()
28 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/context.py:
--------------------------------------------------------------------------------
  1 | """
  2 | The MIT License (MIT)
  3 | 
  4 | Copyright (c) 2015-present Rapptz
  5 | 
  6 | Permission is hereby granted, free of charge, to any person obtaining a
  7 | copy of this software and associated documentation files (the "Software"),
  8 | to deal in the Software without restriction, including without limitation
  9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
 10 | and/or sell copies of the Software, and to permit persons to whom the
 11 | Software is furnished to do so, subject to the following conditions:
 12 | 
 13 | The above copyright notice and this permission notice shall be included in
 14 | all copies or substantial portions of the Software.
 15 | 
 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 17 | OR 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
 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 22 | DEALINGS IN THE SOFTWARE.
 23 | """
 24 | 
 25 | 
 26 | from typing import Any, Optional, Union
 27 | from rebootpy.party import ClientParty, PartyMember, ClientPartyMember
 28 | from rebootpy.friend import Friend
 29 | from rebootpy.user import ClientUser
 30 | 
 31 | 
 32 | class Context:
 33 |     r"""Represents the context in which a command is being invoked under.
 34 | 
 35 |     This class contains a lot of meta data to help you understand more about
 36 |     the invocation context. This class is not created manually and is instead
 37 |     passed around to commands as the first parameter.
 38 | 
 39 |     Attributes
 40 |     -----------
 41 |     message: Union[:class:`.FriendMessage`, :class:`.PartyMessage`]
 42 |         The message that triggered the command being executed.
 43 |     bot: :class:`.Bot`
 44 |         The bot that contains the command being executed.
 45 |     args: :class:`list`
 46 |         The list of transformed arguments that were passed into the command.
 47 |         If this is accessed during the :func:`event_command_error` event
 48 |         then this list could be incomplete.
 49 |     kwargs: :class:`dict`
 50 |         A dictionary of transformed arguments that were passed into the
 51 |         command. Similar to :attr:`args`\, if this is accessed in the
 52 |         :func:`event_command_error` event then this dict could be incomplete.
 53 |     prefix: :class:`str`
 54 |         The prefix that was used to invoke the command.
 55 |     command
 56 |         The command (i.e. :class:`.Command` or its subclasses) that is being
 57 |         invoked currently.
 58 |     invoked_with: :class:`str`
 59 |         The command name that triggered this invocation. Useful for finding out
 60 |         which alias called the command.
 61 |     invoked_subcommand
 62 |         The subcommand (i.e. :class:`.Command` or its subclasses) that was
 63 |         invoked. If no valid subcommand was invoked then this is equal to
 64 |         ``None``.
 65 |     subcommand_passed: Optional[:class:`str`]
 66 |         The string that was attempted to call a subcommand. This does not have
 67 |         to point to a valid registered subcommand and could just point to a
 68 |         nonsense string. If nothing was passed to attempt a call to a
 69 |         subcommand then this is set to ``None``.
 70 |     command_failed: :class:`bool`
 71 |         A boolean that indicates if the command failed to be parsed, checked,
 72 |         or invoked.
 73 |     """
 74 | 
 75 |     def __init__(self, **attrs: dict) -> None:
 76 |         self.message = attrs.pop('message', None)
 77 |         self.bot = attrs.pop('bot', None)
 78 |         self.args = attrs.pop('args', [])
 79 |         self.kwargs = attrs.pop('kwargs', {})
 80 |         self.prefix = attrs.pop('prefix')
 81 |         self.command = attrs.pop('command', None)
 82 |         self.view = attrs.pop('view', None)
 83 |         self.invoked_with = attrs.pop('invoked_with', None)
 84 |         self.invoked_subcommand = attrs.pop('invoked_subcommand', None)
 85 |         self.subcommand_passed = attrs.pop('subcommand_passed', None)
 86 |         self.command_failed = attrs.pop('command_failed', False)
 87 | 
 88 |     async def invoke(self, *args: list, **kwargs: dict) -> Any:
 89 |         r"""|coro|
 90 | 
 91 |         Calls a command with the arguments given.
 92 | 
 93 |         This is useful if you want to just call the callback that a
 94 |         :class:`.Command` holds internally.
 95 | 
 96 |         .. note::
 97 | 
 98 |             This does not handle converters, checks, cooldowns, pre-invoke,
 99 |             or after-invoke hooks in any matter. It calls the internal callback
100 |             directly as-if it was a regular function.
101 | 
102 |             You must take care in passing the proper arguments when
103 |             using this function.
104 | 
105 |         .. warning::
106 | 
107 |             The first parameter passed **must** be the command being invoked.
108 | 
109 |         Parameters
110 |         -----------
111 |         command: :class:`.Command`
112 |             A command or subclass of a command that is going to be called.
113 |         \*args
114 |             The arguments to to use.
115 |         \*\*kwargs
116 |             The keyword arguments to use.
117 |         """
118 | 
119 |         try:
120 |             command = args[0]
121 |         except IndexError:
122 |             raise TypeError('Missing command to invoke.') from None
123 | 
124 |         arguments = []
125 |         if command.cog is not None:
126 |             arguments.append(command.cog)
127 | 
128 |         arguments.append(self)
129 |         arguments.append(args[1:])
130 | 
131 |         ret = await command.callback(*args, **kwargs)
132 |         return ret
133 | 
134 |     async def reinvoke(self, *, call_hooks: bool = False,
135 |                        restart: bool = True) -> None:
136 |         """|coro|
137 | 
138 |         Calls the command again.
139 | 
140 |         This is similar to :meth:`~.Context.invoke` except that it bypasses
141 |         checks, cooldowns, and error handlers.
142 | 
143 |         .. note::
144 |             If you want to bypass :exc:`.UserInputError` derived exceptions,
145 |             it is recommended to use the regular :meth:`~.Context.invoke`
146 |             as it will work more naturally. After all, this will end up
147 |             using the old arguments the user has used and will thus just
148 |             fail again.
149 | 
150 |         Parameters
151 |         ------------
152 |         call_hooks: :class:`bool`
153 |             Whether to call the before and after invoke hooks.
154 |         restart: :class:`bool`
155 |             Whether to start the call chain from the very beginning
156 |             or where we left off (i.e. the command that caused the error).
157 |             The default is to start where we left off.
158 |         """
159 | 
160 |         cmd = self.command
161 |         view = self.view
162 |         if cmd is None:
163 |             raise ValueError('This context is not valid.')
164 | 
165 |         index, previous = view.index, view.previous
166 |         invoked_with = self.invoked_with
167 |         invoked_subcommand = self.invoked_subcommand
168 |         subcommand_passed = self.subcommand_passed
169 | 
170 |         if restart:
171 |             to_call = cmd.root_parent or cmd
172 |             view.index = len(self.prefix)
173 |             view.previous = 0
174 |             view.get_word()  # advance to get the root command
175 |         else:
176 |             to_call = cmd
177 | 
178 |         try:
179 |             await to_call.reinvoke(self, call_hooks=call_hooks)
180 |         finally:
181 |             self.command = cmd
182 |             view.index = index
183 |             view.previous = previous
184 |             self.invoked_with = invoked_with
185 |             self.invoked_subcommand = invoked_subcommand
186 |             self.subcommand_passed = subcommand_passed
187 | 
188 |     @property
189 |     def valid(self) -> bool:
190 |         """:class:`bool`: Checks if the invocation context is valid to be
191 |         invoked with.
192 |         """
193 |         return self.prefix is not None and self.command is not None
194 | 
195 |     @property
196 |     def cog(self) -> Optional['Cog']:
197 |         """Optional[:class:`.Cog`]: Returns the cog associated with this
198 |         context's command. ``None`` if it does not exist.
199 |         """
200 | 
201 |         if self.command is None:
202 |             return None
203 | 
204 |         return self.command.cog
205 | 
206 |     @property
207 |     def party(self) -> ClientParty:
208 |         """Optional[:class:`rebootpy.ClientParty`]: The party this message
209 |         was sent from. ``None`` if the message was not sent from a party.
210 |         """
211 |         return getattr(self.message, 'party', None)
212 | 
213 |     @property
214 |     def author(self) -> Union[Friend, PartyMember]:
215 |         """Union[:class:`rebootpy.Friend`, :class:`rebootpy.PartyMember`]:
216 |         The author of the message.
217 |         """  # noqa
218 |         return self.message.author
219 | 
220 |     @property
221 |     def friend(self) -> Optional['Friend']:
222 |         """Optional[:class:`rebootpy.Friend`]:
223 |         The :class:`rebootpy.Friend` object for this friend, ``None`` if the
224 |         client is not friends with the author.
225 |         """
226 |         return self.message.author if isinstance(
227 |             self.message.author, Friend
228 |         ) else self.bot.get_friend(self.message.author.id)
229 | 
230 |     @property
231 |     def member(self) -> Optional['PartyMember']:
232 |         """Optional[:class:`rebootpy.PartyMember`]:
233 |         The :class:`rebootpy.PartyMember` object for this friend, ``None`` if
234 |         the client is not in the same party as the author.
235 |         """
236 |         return self.message.author if isinstance(
237 |             self.message.author, PartyMember
238 |         ) else self.bot.party.get_member(self.message.author.id)
239 | 
240 |     @property
241 |     def me(self) -> Union[ClientPartyMember, ClientUser]:
242 |         """Union[:class:`rebootpy.ClientPartyMember`, :class:`rebootpy.ClientUser`]:
243 |         Similar to :attr:`rebootpy.ClientPartyMember` except that it returns
244 |         :class:`rebootpy.ClientUser` when not sent from a party.
245 |         """  # noqa
246 |         return self.party.me if self.party is not None else self.bot.user
247 | 
248 |     def get_destination(self) -> Union[ClientParty, Friend]:
249 |         return self.party if self.party is not None else self.author
250 | 
251 |     async def send(self, content: str) -> None:
252 |         """|coro|
253 | 
254 |         Sends a message to the context destination.
255 | 
256 |         Parameters
257 |         ----------
258 |         content: :class:`str`
259 |             The contents of the message.
260 |         """
261 |         destination = self.get_destination()
262 |         await destination.send(content)
263 | 
264 |     async def send_help(self, *args: list, page: int = 1) -> Any:
265 |         """send_help(entity=<bot>, page=1)
266 | 
267 |         |coro|
268 | 
269 |         Shows the help command for the specified entity if given.
270 |         The entity can be a command or a cog.
271 | 
272 |         If no entity is given, then it'll show help for the
273 |         entire bot.
274 | 
275 |         If the entity is a string, then it looks up whether it's a
276 |         :class:`Cog` or a :class:`Command`.
277 | 
278 |         .. note::
279 | 
280 |             Due to the way this function works, instead of returning
281 |             something similar to
282 |             :meth:`~.commands.HelpCommand.command_not_found`
283 |             this returns :class:`None` on bad input or no help command.
284 | 
285 |         Parameters
286 |         ------------
287 |         entity: Optional[Union[:class:`Command`, :class:`Cog`, :class:`str`]]
288 |             The entity to show help for.
289 |         page: :class:`int`
290 |             The page to show. Only has an effect if the entity is either
291 |             the bot or a cog.
292 | 
293 |         Returns
294 |         --------
295 |         Any
296 |             The result of the help command, if any.
297 |         """
298 | 
299 |         from .core import Group, Command, wrap_callback
300 |         from .errors import CommandError
301 | 
302 |         bot = self.bot
303 |         cmd = bot.help_command
304 | 
305 |         if cmd is None:
306 |             return None
307 | 
308 |         cmd = cmd.copy()
309 |         cmd.context = self
310 |         if len(args) == 0:
311 |             await cmd.prepare_help_command(self, None)
312 |             injected = wrap_callback(cmd.send_bot_help)
313 |             try:
314 |                 return await injected(page=page)
315 |             except CommandError as e:
316 |                 await cmd.help_command_error_handler(self, e)
317 |                 return None
318 | 
319 |         entity = args[0]
320 |         if entity is None:
321 |             return None
322 | 
323 |         if isinstance(entity, str):
324 |             entity = bot.get_cog(entity) or bot.get_command(entity)
325 | 
326 |         if not hasattr(entity, 'qualified_name'):
327 |             return None
328 | 
329 |         await cmd.prepare_help_command(self, entity.qualified_name)
330 | 
331 |         try:
332 |             if hasattr(entity, '__cog_commands__'):
333 |                 injected = wrap_callback(cmd.send_cog_help)
334 |                 return await injected(entity, page=page)
335 |             elif isinstance(entity, Group):
336 |                 injected = wrap_callback(cmd.send_group_help)
337 |                 return await injected(entity)
338 |             elif isinstance(entity, Command):
339 |                 injected = wrap_callback(cmd.send_command_help)
340 |                 return await injected(entity)
341 |             else:
342 |                 return None
343 |         except CommandError as e:
344 |             await cmd.help_command_error_handler(self, e)
345 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/converter.py:
--------------------------------------------------------------------------------
  1 | """
  2 | The MIT License (MIT)
  3 | 
  4 | Copyright (c) 2015-present Rapptz
  5 | 
  6 | Permission is hereby granted, free of charge, to any person obtaining a
  7 | copy of this software and associated documentation files (the "Software"),
  8 | to deal in the Software without restriction, including without limitation
  9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
 10 | and/or sell copies of the Software, and to permit persons to whom the
 11 | Software is furnished to do so, subject to the following conditions:
 12 | 
 13 | The above copyright notice and this permission notice shall be included in
 14 | all copies or substantial portions of the Software.
 15 | 
 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 17 | OR 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
 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 22 | DEALINGS IN THE SOFTWARE.
 23 | """
 24 | 
 25 | 
 26 | import re
 27 | 
 28 | from typing import Any, Optional
 29 | from rebootpy.user import User
 30 | from rebootpy.party import PartyMember
 31 | from rebootpy.friend import Friend
 32 | 
 33 | from .errors import BadArgument
 34 | from .context import Context
 35 | 
 36 | 
 37 | __all__ = (
 38 |     'Converter',
 39 |     'IDConverter',
 40 |     'UserConverter',
 41 |     'PartyMemberConverter',
 42 |     'FriendConverter',
 43 |     'IDConverter',
 44 |     'Greedy',
 45 | )
 46 | 
 47 | 
 48 | class Converter:
 49 |     """The base class of custom converters that require the :class:`.Context`
 50 |     to be passed to be useful.
 51 | 
 52 |     This allows you to implement converters that function similar to the
 53 |     special cased ``rebootpy`` classes.
 54 | 
 55 |     Classes that derive from this should override the
 56 |     :meth:`~.Converter.convert` method to do its conversion logic. This method
 57 |     must be a coroutine.
 58 |     """
 59 | 
 60 |     async def convert(self, ctx: 'Context', argument: str) -> Any:
 61 |         """|coro|
 62 | 
 63 |         The method to override to do conversion logic.
 64 | 
 65 |         If an error is found while converting, it is recommended to
 66 |         raise a :exc:`.CommandError` derived exception as it will
 67 |         properly propagate to the error handlers.
 68 | 
 69 |         Parameters
 70 |         -----------
 71 |         ctx: :class:`.Context`
 72 |             The invocation context that the argument is being used in.
 73 |         argument: :class:`str`
 74 |             The argument that is being converted.
 75 |         """
 76 |         raise NotImplementedError('Derived classes need to implement this.')
 77 | 
 78 | 
 79 | class IDConverter(Converter):
 80 |     def __init__(self) -> None:
 81 |         self._id_regex = re.compile(r'([0-9a-fA-F]{32})$')
 82 | 
 83 |     def _get_id_match(self, argument: str) -> Any:
 84 |         return self._id_regex.match(argument)
 85 | 
 86 | 
 87 | class UserConverter(IDConverter):
 88 |     """Converts to a :class:`~rebootpy.User`.
 89 | 
 90 |     The lookup strategy is as follows (in order):
 91 |     1. Cache lookup by ID.
 92 |     2. Cache lookup by display name.
 93 |     3. API Request to fetch the user by id/display name.
 94 |     """
 95 | 
 96 |     async def convert(self, ctx: Context, argument: str) -> User:
 97 |         bot = ctx.bot
 98 |         match = self._get_id_match(argument)
 99 | 
100 |         if match is not None:
101 |             to_lookup = match.group(1).lower()
102 |         else:
103 |             to_lookup = argument
104 | 
105 |         result = await bot.fetch_user(to_lookup, cache=True)
106 | 
107 |         if result is None:
108 |             raise BadArgument('User "{}" not found'.format(argument))
109 | 
110 |         return result
111 | 
112 | 
113 | class PartyMemberConverter(IDConverter):
114 |     """Converts to a :class:`~rebootpy.PartyMember`.
115 | 
116 |     All lookups are done via the bots party member cache.
117 | 
118 |     The lookup strategy is as follows (in order):
119 |     1. Lookup by ID.
120 |     2. Lookup by display name.
121 |     """
122 | 
123 |     async def convert(self, ctx: Context, argument: str) -> PartyMember:
124 |         bot = ctx.bot
125 |         match = self._get_id_match(argument)
126 |         party = ctx.party or bot.party
127 | 
128 |         result = None
129 |         if match is None:
130 |             for member in party._members.values():
131 |                 if member.display_name.casefold() == argument.casefold():
132 |                     result = member
133 |                     break
134 |         else:
135 |             user_id = match.group(1).lower()
136 |             result = party.get_member(user_id)
137 | 
138 |         if result is None:
139 |             raise BadArgument('Party member "{}" not found'.format(argument))
140 | 
141 |         return result
142 | 
143 | 
144 | class FriendConverter(IDConverter):
145 |     """Converts to a :class:`~rebootpy.Friend`.
146 | 
147 |     All lookups are via the friend cache.
148 | 
149 |     The lookup strategy is as follows (in order):
150 |     1. Lookup by ID.
151 |     2. Lookup by display name.
152 |     """
153 | 
154 |     async def convert(self, ctx: Context, argument: str) -> Friend:
155 |         bot = ctx.bot
156 |         match = self._get_id_match(argument)
157 | 
158 |         result = None
159 |         if match is not None:
160 |             user_id = match.group(1).lower()
161 |             result = bot.get_friend(user_id)
162 |         else:
163 |             for friend in bot._friends.values():
164 |                 if friend.display_name.casefold() == argument.casefold():
165 |                     result = friend
166 |                     break
167 | 
168 |         if result is None:
169 |             raise BadArgument('Friend "{}" not found'.format(argument))
170 | 
171 |         return result
172 | 
173 | 
174 | class _Greedy:
175 |     __slots__ = ('converter',)
176 | 
177 |     def __init__(self, *, converter: Optional[Converter] = None) -> None:
178 |         self.converter = converter
179 | 
180 |     def __getitem__(self, params: Any) -> Any:
181 |         if not isinstance(params, tuple):
182 |             params = (params,)
183 |         if len(params) != 1:
184 |             raise TypeError('Greedy[...] only takes a single argument')
185 | 
186 |         converter = params[0]
187 | 
188 |         if not (callable(converter) or isinstance(converter, Converter)
189 |                 or hasattr(converter, '__origin__')):
190 |             raise TypeError('Greedy[...] expects a type or a Converter '
191 |                             'instance.')
192 | 
193 |         NoneType = type(None)
194 |         if converter is str or converter is NoneType or converter is _Greedy:
195 |             raise TypeError('Greedy[%s] is invalid.' % converter.__name__)
196 | 
197 |         return self.__class__(converter=converter)
198 | 
199 | 
200 | Greedy = _Greedy()
201 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/cooldown.py:
--------------------------------------------------------------------------------
  1 | """
  2 | The MIT License (MIT)
  3 | 
  4 | Copyright (c) 2015-present Rapptz
  5 | 
  6 | Permission is hereby granted, free of charge, to any person obtaining a
  7 | copy of this software and associated documentation files (the "Software"),
  8 | to deal in the Software without restriction, including without limitation
  9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
 10 | and/or sell copies of the Software, and to permit persons to whom the
 11 | Software is furnished to do so, subject to the following conditions:
 12 | 
 13 | The above copyright notice and this permission notice shall be included in
 14 | all copies or substantial portions of the Software.
 15 | 
 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 17 | OR 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
 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 22 | DEALINGS IN THE SOFTWARE.
 23 | """
 24 | 
 25 | 
 26 | import time
 27 | import asyncio
 28 | 
 29 | from rebootpy.enums import Enum
 30 | from collections import deque
 31 | from typing import Any, Optional
 32 | 
 33 | from .typedefs import Message
 34 | from .errors import MaxConcurrencyReached
 35 | 
 36 | __all__ = (
 37 |     'BucketType',
 38 |     'Cooldown',
 39 |     'CooldownMapping',
 40 |     'MaxConcurrency',
 41 | )
 42 | 
 43 | 
 44 | class BucketType(Enum):
 45 |     default = 0
 46 |     user = 1
 47 | 
 48 |     def get_key(self, msg: Message) -> Any:
 49 |         if self is BucketType.user:
 50 |             return msg.author.id
 51 | 
 52 | 
 53 | class Cooldown:
 54 |     __slots__ = ('rate', 'per', 'type', '_window', '_tokens', '_last')
 55 | 
 56 |     def __init__(self, rate: int, per: float, type: BucketType) -> None:
 57 |         self.rate = int(rate)
 58 |         self.per = float(per)
 59 |         self.type = type
 60 |         self._window = 0.0
 61 |         self._tokens = self.rate
 62 |         self._last = 0.0
 63 | 
 64 |         if not isinstance(self.type, BucketType):
 65 |             raise TypeError('Cooldown type must be a BucketType')
 66 | 
 67 |     def get_tokens(self, current: Optional[float] = None) -> int:
 68 |         if not current:
 69 |             current = time.time()
 70 | 
 71 |         tokens = self._tokens
 72 | 
 73 |         if current > self._window + self.per:
 74 |             tokens = self.rate
 75 |         return tokens
 76 | 
 77 |     def update_rate_limit(self,
 78 |                           current: Optional[float] = None) -> Optional[float]:
 79 |         current = current or time.time()
 80 |         self._last = current
 81 | 
 82 |         self._tokens = self.get_tokens(current)
 83 | 
 84 |         # first token used means that we start a new rate limit window
 85 |         if self._tokens == self.rate:
 86 |             self._window = current
 87 | 
 88 |         # check if we are rate limited
 89 |         if self._tokens == 0:
 90 |             return self.per - (current - self._window)
 91 | 
 92 |         # we're not so decrement our tokens
 93 |         self._tokens -= 1
 94 | 
 95 |         # see if we got rate limited due to this token change, and if
 96 |         # so update the window to point to our current time frame
 97 |         if self._tokens == 0:
 98 |             self._window = current
 99 | 
100 |     def reset(self) -> None:
101 |         self._tokens = self.rate
102 |         self._last = 0.0
103 | 
104 |     def copy(self) -> 'Cooldown':
105 |         return Cooldown(self.rate, self.per, self.type)
106 | 
107 |     def __repr__(self) -> str:
108 |         return ('<Cooldown rate: {0.rate} per: {0.per} window: {0._window} '
109 |                 'tokens: {0._tokens}>'.format(self))
110 | 
111 | 
112 | class CooldownMapping:
113 |     def __init__(self, original: Cooldown) -> None:
114 |         self._cache = {}
115 |         self._cooldown = original
116 | 
117 |     def copy(self) -> 'CooldownMapping':
118 |         ret = CooldownMapping(self._cooldown)
119 |         ret._cache = self._cache.copy()
120 |         return ret
121 | 
122 |     @property
123 |     def valid(self) -> bool:
124 |         return self._cooldown is not None
125 | 
126 |     @classmethod
127 |     def from_cooldown(cls, rate: int,
128 |                       per: float,
129 |                       type: BucketType) -> 'CooldownMapping':
130 |         return cls(Cooldown(rate, per, type))
131 | 
132 |     def _bucket_key(self, msg: Message) -> Any:
133 |         return self._cooldown.type.get_key(msg)
134 | 
135 |     def _verify_cache_integrity(self, current: Optional[float] = None) -> None:
136 |         # we want to delete all cache objects that haven't been used
137 |         # in a cooldown window. e.g. if we have a  command that has a
138 |         # cooldown of 60s and it has not been used in 60s then that key should
139 |         # be deleted
140 |         current = current or time.time()
141 |         dead_keys = [k for k, v in self._cache.items()
142 |                      if current > v._last + v.per]
143 |         for k in dead_keys:
144 |             del self._cache[k]
145 | 
146 |     def get_bucket(self, message: Message,
147 |                    current: Optional[float] = None) -> Cooldown:
148 |         if self._cooldown.type is BucketType.default:
149 |             return self._cooldown
150 | 
151 |         self._verify_cache_integrity(current)
152 |         key = self._bucket_key(message)
153 |         if key not in self._cache:
154 |             bucket = self._cooldown.copy()
155 |             self._cache[key] = bucket
156 |         else:
157 |             bucket = self._cache[key]
158 | 
159 |         return bucket
160 | 
161 |     def update_rate_limit(self, message: Message,
162 |                           current: Optional[float] = None) -> Optional[float]:
163 |         bucket = self.get_bucket(message, current)
164 |         return bucket.update_rate_limit(current)
165 | 
166 | 
167 | class _Semaphore:
168 |     __slots__ = ('value', 'loop', '_waiters')
169 | 
170 |     def __init__(self, number: int) -> None:
171 |         self.value = number
172 |         self.loop = asyncio.get_running_loop()
173 |         self._waiters = deque()
174 | 
175 |     def __repr__(self) -> str:
176 |         return ('<_Semaphore value={0.value} waiters={1}>'
177 |                 ''.format(self, len(self._waiters)))
178 | 
179 |     def locked(self) -> bool:
180 |         return self.value == 0
181 | 
182 |     def is_active(self) -> bool:
183 |         return len(self._waiters) > 0
184 | 
185 |     def wake_up(self) -> None:
186 |         while self._waiters:
187 |             future = self._waiters.popleft()
188 |             if not future.done():
189 |                 future.set_result(None)
190 |                 return
191 | 
192 |     async def acquire(self, *, wait: bool = False) -> bool:
193 |         if not wait and self.value <= 0:
194 |             # signal that we're not acquiring
195 |             return False
196 | 
197 |         while self.value <= 0:
198 |             future = self.loop.create_future()
199 |             self._waiters.append(future)
200 |             try:
201 |                 await future
202 |             except Exception:
203 |                 future.cancel()
204 |                 if self.value > 0 and not future.cancelled():
205 |                     self.wake_up()
206 |                 raise
207 | 
208 |         self.value -= 1
209 |         return True
210 | 
211 |     def release(self) -> None:
212 |         self.value += 1
213 |         self.wake_up()
214 | 
215 | 
216 | class MaxConcurrency:
217 |     __slots__ = ('number', 'per', 'wait', '_mapping')
218 | 
219 |     def __init__(self, number: int, *, per: BucketType, wait: bool) -> None:
220 |         self._mapping = {}
221 |         self.per = per
222 |         self.number = number
223 |         self.wait = wait
224 | 
225 |         if number <= 0:
226 |             raise ValueError('max_concurrency \'number\' cannot be less '
227 |                              'than 1')
228 | 
229 |         if not isinstance(per, BucketType):
230 |             raise TypeError('max_concurrency \'per\' must be of type '
231 |                             'BucketType not %r' % type(per))
232 | 
233 |     def copy(self) -> 'MaxConcurrency':
234 |         return self.__class__(self.number, per=self.per, wait=self.wait)
235 | 
236 |     def __repr__(self) -> str:
237 |         return ('<MaxConcurrency per={0.per!r} number={0.number} '
238 |                 'wait={0.wait}>'.format(self))
239 | 
240 |     def get_key(self, message: Message) -> Any:
241 |         return self.per.get_key(message)
242 | 
243 |     async def acquire(self, message: Message) -> None:
244 |         key = self.get_key(message)
245 | 
246 |         try:
247 |             sem = self._mapping[key]
248 |         except KeyError:
249 |             self._mapping[key] = sem = _Semaphore(self.number)
250 | 
251 |         acquired = await sem.acquire(wait=self.wait)
252 |         if not acquired:
253 |             raise MaxConcurrencyReached(self.number, self.per)
254 | 
255 |     async def release(self, message: Message) -> None:
256 |         # Technically there's no reason for this function to be async
257 |         # But it might be more useful in the future
258 |         key = self.get_key(message)
259 | 
260 |         try:
261 |             sem = self._mapping[key]
262 |         except KeyError:
263 |             # ...? peculiar
264 |             return
265 |         else:
266 |             sem.release()
267 | 
268 |         if sem.value >= self.number and not sem.is_active():
269 |             del self._mapping[key]
270 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/typedefs.py:
--------------------------------------------------------------------------------
 1 | """
 2 | The MIT License (MIT)
 3 | 
 4 | Copyright (c) 2015-present Rapptz
 5 | 
 6 | Permission is hereby granted, free of charge, to any person obtaining a
 7 | copy of this software and associated documentation files (the "Software"),
 8 | to deal in the Software without restriction, including without limitation
 9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 | and/or sell copies of the Software, and to permit persons to whom the
11 | Software is furnished to do so, subject to the following conditions:
12 | 
13 | The above copyright notice and this permission notice shall be included in
14 | all copies or substantial portions of the Software.
15 | 
16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 | OR 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
21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 | DEALINGS IN THE SOFTWARE.
23 | """
24 | 
25 | 
26 | from typing import Union
27 | from rebootpy import FriendMessage, PartyMessage
28 | 
29 | 
30 | Message = Union[FriendMessage, PartyMessage]
31 | 


--------------------------------------------------------------------------------
/rebootpy/ext/commands/view.py:
--------------------------------------------------------------------------------
  1 | """
  2 | The MIT License (MIT)
  3 | 
  4 | Copyright (c) 2015-present Rapptz
  5 | 
  6 | Permission is hereby granted, free of charge, to any person obtaining a
  7 | copy of this software and associated documentation files (the "Software"),
  8 | to deal in the Software without restriction, including without limitation
  9 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
 10 | and/or sell copies of the Software, and to permit persons to whom the
 11 | Software is furnished to do so, subject to the following conditions:
 12 | 
 13 | The above copyright notice and this permission notice shall be included in
 14 | all copies or substantial portions of the Software.
 15 | 
 16 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 17 | OR 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
 21 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 22 | DEALINGS IN THE SOFTWARE.
 23 | """
 24 | 
 25 | 
 26 | from typing import Optional
 27 | 
 28 | from .errors import (UnexpectedQuoteError, InvalidEndOfQuotedStringError,
 29 |                      ExpectedClosingQuoteError)
 30 | 
 31 | # map from opening quotes to closing quotes
 32 | _quotes = {
 33 |     '"': '"',
 34 |     "‘": "’",
 35 |     "‚": "‛",
 36 |     "“": "”",
 37 |     "„": "‟",
 38 |     "⹂": "⹂",
 39 |     "「": "」",
 40 |     "『": "』",
 41 |     "〝": "〞",
 42 |     "﹁": "﹂",
 43 |     "﹃": "﹄",
 44 |     "＂": "＂",
 45 |     "｢": "｣",
 46 |     "«": "»",
 47 |     "‹": "›",
 48 |     "《": "》",
 49 |     "〈": "〉",
 50 | }
 51 | _all_quotes = set(_quotes.keys()) | set(_quotes.values())
 52 | 
 53 | 
 54 | class StringView:
 55 |     def __init__(self, buffer: str) -> None:
 56 |         self.index = 0
 57 |         self.buffer = buffer.strip()
 58 |         self.end = len(buffer)
 59 |         self.previous = 0
 60 | 
 61 |     @property
 62 |     def current(self) -> Optional[str]:
 63 |         return None if self.eof else self.buffer[self.index]
 64 | 
 65 |     @property
 66 |     def eof(self) -> bool:
 67 |         return self.index >= self.end
 68 | 
 69 |     def undo(self) -> None:
 70 |         self.index = self.previous
 71 | 
 72 |     def skip_ws(self) -> bool:
 73 |         pos = 0
 74 |         while not self.eof:
 75 |             try:
 76 |                 current = self.buffer[self.index + pos]
 77 |                 if not current.isspace():
 78 |                     break
 79 |                 pos += 1
 80 |             except IndexError:
 81 |                 break
 82 | 
 83 |         self.previous = self.index
 84 |         self.index += pos
 85 |         return self.previous != self.index
 86 | 
 87 |     def skip_string(self, string: str) -> bool:
 88 |         strlen = len(string)
 89 |         if self.buffer[self.index:self.index + strlen] == string:
 90 |             self.previous = self.index
 91 |             self.index += strlen
 92 |             return True
 93 |         return False
 94 | 
 95 |     def read_rest(self) -> str:
 96 |         result = self.buffer[self.index:]
 97 |         self.previous = self.index
 98 |         self.index = self.end
 99 |         return result
100 | 
101 |     def read(self, n: int) -> str:
102 |         result = self.buffer[self.index:self.index + n]
103 |         self.previous = self.index
104 |         self.index += n
105 |         return result
106 | 
107 |     def get(self) -> Optional[str]:
108 |         try:
109 |             result = self.buffer[self.index + 1]
110 |         except IndexError:
111 |             result = None
112 | 
113 |         self.previous = self.index
114 |         self.index += 1
115 |         return result
116 | 
117 |     def get_word(self) -> str:
118 |         pos = 0
119 |         while not self.eof:
120 |             try:
121 |                 current = self.buffer[self.index + pos]
122 |                 if current.isspace():
123 |                     break
124 |                 pos += 1
125 |             except IndexError:
126 |                 break
127 |         self.previous = self.index
128 |         result = self.buffer[self.index:self.index + pos]
129 |         self.index += pos
130 |         return result
131 | 
132 |     def get_quoted_word(self) -> Optional[str]:
133 |         current = self.current
134 |         if current is None:
135 |             return None
136 | 
137 |         close_quote = _quotes.get(current)
138 |         is_quoted = bool(close_quote)
139 |         if is_quoted:
140 |             result = []
141 |             _escaped_quotes = (current, close_quote)
142 |         else:
143 |             result = [current]
144 |             _escaped_quotes = _all_quotes
145 | 
146 |         while not self.eof:
147 |             current = self.get()
148 |             if not current:
149 |                 if is_quoted:
150 |                     # unexpected EOF
151 |                     raise ExpectedClosingQuoteError(close_quote)
152 |                 return ''.join(result)
153 | 
154 |             # currently we accept strings in the format of "hello world"
155 |             # to embed a quote inside the string you must escape it:
156 |             # "a \"world\""
157 |             if current == '\\':
158 |                 next_char = self.get()
159 |                 if not next_char:
160 |                     # string ends with \ and no character after it
161 |                     if is_quoted:
162 |                         # if we're quoted then we're expecting a closing quote
163 |                         raise ExpectedClosingQuoteError(close_quote)
164 |                     # if we aren't then we just let it through
165 |                     return ''.join(result)
166 | 
167 |                 if next_char in _escaped_quotes:
168 |                     # escaped quote
169 |                     result.append(next_char)
170 |                 else:
171 |                     # different escape character, ignore it
172 |                     self.undo()
173 |                     result.append(current)
174 |                 continue
175 | 
176 |             if not is_quoted and current in _all_quotes:
177 |                 # we aren't quoted
178 |                 raise UnexpectedQuoteError(current)
179 | 
180 |             # closing quote
181 |             if is_quoted and current == close_quote:
182 |                 next_char = self.get()
183 |                 valid_eof = not next_char or next_char.isspace()
184 |                 if not valid_eof:
185 |                     raise InvalidEndOfQuotedStringError(next_char)
186 | 
187 |                 # we're quoted so it's okay
188 |                 return ''.join(result)
189 | 
190 |             if current.isspace() and not is_quoted:
191 |                 # end of word found
192 |                 return ''.join(result)
193 | 
194 |             result.append(current)
195 | 
196 |     def __repr__(self) -> str:
197 |         return ('<StringView pos: {0.index} prev: {0.previous} end: {0.end} '
198 |                 'eof: {0.eof}>'.format(self))
199 | 


--------------------------------------------------------------------------------
/rebootpy/message.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2019-2021 Terbau
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | import datetime
 28 | 
 29 | from typing import TYPE_CHECKING, Union
 30 | 
 31 | if TYPE_CHECKING:
 32 |     from .client import Client
 33 |     from .friend import Friend
 34 |     from .party import ClientParty, PartyMember
 35 | 
 36 | 
 37 | class MessageBase:
 38 | 
 39 |     __slots__ = ('_client', '_author', '_content', '_created_at')
 40 | 
 41 |     def __init__(self, client: 'Client',
 42 |                  author: Union['Friend', 'PartyMember'],
 43 |                  content: str) -> None:
 44 |         self._client = client
 45 |         self._author = author
 46 |         self._content = content
 47 |         self._created_at = datetime.datetime.utcnow()
 48 | 
 49 |     @property
 50 |     def client(self) -> 'Client':
 51 |         """:class:`Client`: The client."""
 52 |         return self._client
 53 | 
 54 |     @property
 55 |     def author(self) -> 'Friend':
 56 |         """:class:`Friend`: The author of the message."""
 57 |         return self._author
 58 | 
 59 |     @property
 60 |     def content(self) -> str:
 61 |         """:class:`str`: The content of the message."""
 62 |         return self._content
 63 | 
 64 |     @property
 65 |     def created_at(self) -> datetime.datetime:
 66 |         """:class:`datetime.datetime`: The time of when this message was
 67 |         received in UTC.
 68 |         """
 69 |         return self._created_at
 70 | 
 71 | 
 72 | class FriendMessage(MessageBase):
 73 | 
 74 |     __slots__ = MessageBase.__slots__
 75 | 
 76 |     def __init__(self, client: 'Client',
 77 |                  author: 'Friend',
 78 |                  content: str) -> None:
 79 |         super().__init__(client, author, content)
 80 | 
 81 |     def __repr__(self) -> str:
 82 |         return ('<FriendMessage author={0.author!r} '
 83 |                 'created_at={0.created_at!r}>'.format(self))
 84 | 
 85 |     async def reply(self, content: str) -> None:
 86 |         """|coro|
 87 | 
 88 |         Replies to the message with the given content.
 89 | 
 90 |         Parameters
 91 |         ----------
 92 |         content: :class:`str`
 93 |             The content of the message, up to 256 characters.
 94 | 
 95 | 
 96 |         Raises
 97 |         ------
 98 |         ChatError
 99 |             Content is longer than 256 characters.
100 |         """
101 |         return await self.author.send(content)
102 | 
103 | 
104 | class PartyMessage(MessageBase):
105 | 
106 |     __slots__ = MessageBase.__slots__ + ('party',)
107 | 
108 |     def __init__(self, client: 'Client',
109 |                  party: 'ClientParty',
110 |                  author: 'PartyMember',
111 |                  content: str) -> None:
112 |         super().__init__(client, author, content)
113 |         self.party = party
114 | 
115 |     def __repr__(self) -> str:
116 |         return ('<PartyMessage party={0.party!r} author={0.author!r} '
117 |                 'created_at={0.created_at!r}>'.format(self))
118 | 
119 |     @property
120 |     def author(self) -> 'PartyMember':
121 |         """:class:`PartyMember`: The author of a message."""
122 |         return self._author
123 | 
124 |     async def reply(self, content: str) -> None:
125 |         """|coro|
126 | 
127 |         Replies to the message with the given content.
128 | 
129 |         Parameters
130 |         ----------
131 |         content: :class:`str`
132 |             The content of the message, up to 256 characters.
133 | 
134 |         Raises
135 |         ------
136 |         ChatError
137 |             Content is longer than 256 characters or the client is in a party
138 |             on its own.
139 |         """
140 |         return await self.party.send(content)
141 | 


--------------------------------------------------------------------------------
/rebootpy/news.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | """
 4 | MIT License
 5 | 
 6 | Copyright (c) 2019-2021 Terbau
 7 | 
 8 | Permission is hereby granted, free of charge, to any person obtaining a copy
 9 | of this software and associated documentation files (the "Software"), to deal
10 | in the Software without restriction, including without limitation the rights
11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 | copies of the Software, and to permit persons to whom the Software is
13 | furnished to do so, subject to the following conditions:
14 | 
15 | The above copyright notice and this permission notice shall be included in all
16 | copies or substantial portions of the Software.
17 | 
18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 | SOFTWARE.
25 | """
26 | 
27 | 
28 | class BattleRoyaleNewsPost:
29 |     def __init__(self, data: dict) -> None:
30 |         self._image = data['image']
31 |         self._hidden = data['hidden']
32 |         self._type = data['_type']
33 |         self._title = data['title']
34 |         self._body = data['body']
35 |         self._spotlight = data['spotlight']
36 |         self._adspace = data.get('adspace')
37 | 
38 |     def __str__(self) -> str:
39 |         return self.title
40 | 
41 |     def __repr__(self) -> str:
42 |         return ('<BattleRoyaleNewsPost title={0.title!r} image={0.image!r} '
43 |                 'spotlight={0.spotlight}>'.format(self))
44 | 
45 |     @property
46 |     def image(self) -> str:
47 |         """:class:`str`: The image url of this post."""
48 |         return self._image
49 | 
50 |     @property
51 |     def hidden(self) -> bool:
52 |         """:class:`bool`: ``True`` if post is hidden else ``False``."""
53 |         return self._hidden
54 | 
55 |     @property
56 |     def type(self) -> str:
57 |         """:class:`str`: The type of this message."""
58 |         return self._type
59 | 
60 |     @property
61 |     def title(self) -> str:
62 |         """:class:`str`: The title of this post."""
63 |         return self._title
64 | 
65 |     @property
66 |     def body(self) -> str:
67 |         """:class:`str`: The actual message of this post."""
68 |         return self._body
69 | 
70 |     @property
71 |     def spotlight(self) -> bool:
72 |         """:class:`bool`: ``True`` if this post is in the spotlight
73 |         else ``False``.
74 |         """
75 |         return self._spotlight
76 | 
77 |     @property
78 |     def adspace(self) -> str:
79 |         """:class:`str`: The adspace of this post. ``None`` if no adspace
80 |         is found.
81 |         """
82 |         return self._adspace
83 | 


--------------------------------------------------------------------------------
/rebootpy/playlist.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2019-2021 Terbau
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | from typing import Optional
 28 | 
 29 | 
 30 | class Playlist:
 31 | 
 32 |     __slots__ = ('_image', '_internal_name', '_special_border', '_type',
 33 |                  '_violator', '_display_subname', '_description')
 34 | 
 35 |     def __init__(self, data: dict) -> None:
 36 |         self._image = data['image']
 37 |         self._internal_name = data['playlist_name']
 38 |         self._special_border = data.get('special_border')
 39 |         self._type = data.get('_type')
 40 |         self._violator = data.get('violator')
 41 |         self._display_subname = data.get('display_subname')
 42 |         self._description = data.get('description')
 43 | 
 44 |     def __str__(self) -> str:
 45 |         return self.internal_name
 46 | 
 47 |     def __repr__(self) -> str:
 48 |         return ('<Playlist internal_name={0.internal_name!r} '
 49 |                 'image_url={0.image_url!r} type={0.type!r}>'.format(self))
 50 | 
 51 |     def __eq__(self, other):
 52 |         return (isinstance(other, Playlist)
 53 |                 and other._internal_name == self._internal_name)
 54 | 
 55 |     def __ne__(self, other):
 56 |         return not self.__eq__(other)
 57 | 
 58 |     @property
 59 |     def image_url(self) -> str:
 60 |         """:class:`str`: Image url for the playlist."""
 61 |         return self._image
 62 | 
 63 |     @property
 64 |     def internal_name(self) -> str:
 65 |         """:class:`str`: The internal name of the playlist."""
 66 |         return self._internal_name
 67 | 
 68 |     @property
 69 |     def type(self) -> str:
 70 |         """:class:`str`: The type of this playlist object."""
 71 |         return self._type
 72 | 
 73 |     @property
 74 |     def special_border(self) -> Optional[str]:
 75 |         """Optional[:class:`str`]: Special border of the playlist.
 76 |         Will be ``None`` if no special border is found for this playlist.
 77 |         """
 78 |         if self._special_border == 'None':
 79 |             return None
 80 |         return self._special_border
 81 | 
 82 |     @property
 83 |     def violator(self) -> Optional[str]:
 84 |         """Optional[:class:`str`]: The violater displayed for this playlist. This is
 85 |         the little red tag displaying short text on some of the playlists
 86 |         in-game.
 87 |         Will be ``None`` if no violator is found for this playlist.
 88 |         """
 89 |         if self._violator == '':
 90 |             return None
 91 |         return self._violator
 92 | 
 93 |     @property
 94 |     def display_subname(self) -> Optional[str]:
 95 |         """Optional[:class:`str`]: The display subname of this playlist.
 96 |         Will be ``None`` if no display subname is found for this playlist.
 97 |         """
 98 |         return self._display_subname
 99 | 
100 |     @property
101 |     def description(self) -> Optional[str]:
102 |         """Optional[:class:`str`]: The description of this playlist.
103 |         Will be ``None`` if no description is found for this playlist.
104 |         """
105 |         return self._description
106 | 


--------------------------------------------------------------------------------
/rebootpy/store.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2019-2021 Terbau
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | import re
 28 | import datetime
 29 | import json
 30 | 
 31 | from typing import TYPE_CHECKING, Optional, List
 32 | 
 33 | from .utils import from_iso
 34 | 
 35 | if TYPE_CHECKING:
 36 |     from .client import Client
 37 | 
 38 | 
 39 | class StoreItem:
 40 |     """Featured store item."""
 41 |     def __init__(self, data: dict) -> None:
 42 |         self._dev_name = data['devName']
 43 |         self._asset_path = data.get('displayAssetPath')
 44 | 
 45 |         try:
 46 |             self._asset = re.search(r'\.(.+)', self._asset_path).group(1)
 47 |         except (TypeError, AttributeError):
 48 |             self._asset = None
 49 | 
 50 |         self._gifts_enabled = (data['giftInfo']['bIsEnabled']
 51 |                                if 'giftInfo' in data else False)
 52 |         self._daily_limit = data['dailyLimit']
 53 |         self._weekly_limit = data['weeklyLimit']
 54 |         self._monthly_limit = data['monthlyLimit']
 55 |         self._offer_id = data['offerId']
 56 |         self._offer_type = data['offerType']
 57 |         self._refundable = data['refundable']
 58 |         self._items_grants = data['itemGrants']
 59 |         self._panel = data['sortPriority']
 60 |         self._meta_info = data.get('metaInfo', [])
 61 |         self._meta = data.get('meta', {})
 62 | 
 63 |         self._raw = data
 64 | 
 65 |     def __str__(self) -> str:
 66 |         return self.dev_name
 67 | 
 68 |     def __repr__(self) -> str:
 69 |         return ('<StoreItem dev_name={0.dev_name!r} asset={0.asset!r} '
 70 |                 'price={0.price!r}>'.format(self))
 71 | 
 72 |     @property
 73 |     def display_names(self) -> List[str]:
 74 |         """List[:class:`str`]: The display names for this item."""
 75 |         match = re.search(r'^\[VIRTUAL][0-9]+ x (.*) for [0-9]+ .*$',
 76 |                           self._dev_name).group(1)
 77 |         return re.split(r', [0-9]+ x ', match)
 78 | 
 79 |     @property
 80 |     def dev_name(self) -> str:
 81 |         """:class:`str`: The dev name of this item."""
 82 |         return self._dev_name
 83 | 
 84 |     @property
 85 |     def asset_path(self) -> Optional[str]:
 86 |         """:class:`str`: The asset path of the item. Could be ``None`` if
 87 |         not found.
 88 |         """
 89 |         return self._asset_path
 90 | 
 91 |     @property
 92 |     def asset(self) -> Optional[str]:
 93 |         """:class:`str`: The asset of the item. Usually a CID or
 94 |         or something similar. Could be ``None`` if not found.
 95 |         """
 96 |         return self._asset
 97 | 
 98 |     @property
 99 |     def encryption_key(self) -> Optional[str]:
100 |         """:class:`str`: The encryption key for this item. If no encryption
101 |         key is found, this will be ``None``.
102 |         """
103 |         for meta in self._meta_info:
104 |             if meta['key'] == 'EncryptionKey':
105 |                 return meta['value']
106 | 
107 |     @property
108 |     def gifts_enabled(self) -> bool:
109 |         """:class:`bool`: ``True`` if gifts is enabled for this
110 |         item else ``False``.
111 |         """
112 |         return self._gifts_enabled
113 | 
114 |     @property
115 |     def daily_limit(self) -> int:
116 |         """:class:`int`: The daily account limit for this item.
117 |         ``-1`` = Unlimited.
118 |         """
119 |         return self._daily_limit
120 | 
121 |     @property
122 |     def weekly_limit(self) -> int:
123 |         """:class:`int`: The weekly account limit for this item.
124 |         ``-1`` = Unlimited.
125 |         """
126 |         return self._weekly_limit
127 | 
128 |     @property
129 |     def monthly_limit(self) -> int:
130 |         """:class:`int`: The monthly account limit for this item.
131 |         ``-1`` = Unlimited.
132 |         """
133 |         return self._monthly_limit
134 | 
135 |     @property
136 |     def offer_id(self) -> str:
137 |         """:class:`str`: The offer id of this item."""
138 |         return self._offer_id
139 | 
140 |     @property
141 |     def offer_type(self) -> str:
142 |         """:class:`str`: The offer type of this item."""
143 |         return self._offer_type
144 | 
145 |     @property
146 |     def price(self) -> int:
147 |         """:class:`int`: The price of this item in v-bucks."""
148 |         if 'dynamicBundleInfo' in self._raw:
149 |             return (
150 |                 self._raw['dynamicBundleInfo']['discountedBasePrice'] + 
151 |                 sum(item['regularPrice'] for item in self._raw['dynamicBundleInfo']['bundleItems'])
152 |             )
153 |         else:
154 |             return self._raw['prices'][0]['finalPrice']
155 | 
156 |     @property
157 |     def refundable(self) -> bool:
158 |         """:class:`bool`: ``True`` if item is refundable else
159 |         ``False``.
160 |         """
161 |         return self._refundable
162 | 
163 |     @property
164 |     def grants(self) -> List[dict]:
165 |         """:class:`list`: A list of items you get from this purchase.
166 | 
167 |         Typical output: ::
168 | 
169 |             [{
170 |                 'quantity': 1,
171 |                 'type': 'AthenaCharacter',
172 |                 'asset': 'cid_318_athena_commando_m_demon'
173 |             }]
174 |         """
175 |         grants = []
176 |         for item in self._items_grants:
177 |             _type, _asset = item['templateId'].split(':')
178 |             grants.append({
179 |                 'quantity': item['quantity'],
180 |                 'type': _type,
181 |                 'asset': _asset
182 |             })
183 |         return grants
184 | 
185 |     @property
186 |     def new(self) -> bool:
187 |         """:class:`bool`: ``True`` if the item is in the item shop for
188 |         the first time, else ``False``.
189 |         """
190 |         for meta in self._meta_info:
191 |             if meta['value'].lower() == 'new':
192 |                 return True
193 |         return False
194 | 
195 |     @property
196 |     def violator(self) -> Optional[str]:
197 |         """:class:`str`: The violator of this item. Violator is the
198 |         red tag at the top of an item in the shop. Will be ``None``
199 |         if no violator is found for this item.
200 |         """
201 |         unfixed = self._meta.get('BannerOverride')
202 |         if unfixed:
203 |             return ' '.join(re.findall(r'[A-Z][^A-Z]*', unfixed))
204 | 
205 |     @property
206 |     def panel(self) -> int:
207 |         """:class:`int`: The panel the item is listed in from left
208 |         to right.
209 |         """
210 |         return self._panel
211 | 
212 | 
213 | class Store:
214 |     """Object representing store data from Fortnite Battle Royale.
215 | 
216 |     Attributes
217 |     ----------
218 |     client: :class:`Client`
219 |         The client.
220 |     """
221 |     def __init__(self, client: 'Client', data: dict) -> None:
222 |         self.client = client
223 |         self._daily_purchase_hours = data['dailyPurchaseHrs']
224 |         self._refresh_interval_hours = data['refreshIntervalHrs']
225 |         self._expires_at = from_iso(data['expiration'])
226 | 
227 |         self._items = self._create_store_items(data)
228 | 
229 |     def __repr__(self) -> str:
230 |         return ('<Store created_at={0.created_at!r} '
231 |                 'expires_at={0.expires_at!r}>'.format(self))
232 | 
233 |     @property
234 |     def items(self) -> List[StoreItem]:
235 |         """List[:class:`StoreItem`]: A list containing data about
236 |         all items in the item shop.
237 |         """
238 |         return self._items
239 | 
240 |     @property
241 |     def daily_purchase_hours(self) -> int:
242 |         """:class:`int`: How many hours a day it is possible to purchase
243 |         items. It most likely is ``24``.
244 |         """
245 |         return self._daily_purchase_hours
246 | 
247 |     @property
248 |     def refresh_interval_hours(self) -> int:
249 |         """:class:`int`: Refresh interval hours."""
250 |         return self._refresh_interval_hours
251 | 
252 |     @property
253 |     def created_at(self) -> datetime.datetime:
254 |         """:class:`datetime.datetime`: The UTC time of the creation
255 |         and current day.
256 |         """
257 |         return self._expires_at - datetime.timedelta(days=1)
258 | 
259 |     @property
260 |     def expires_at(self) -> datetime.datetime:
261 |         """:class:`datetime.datetime`: The UTC time of when this
262 |         item shop expires.
263 |         """
264 |         return self._expires_at
265 | 
266 |     def _find_storefront(self, data: dict, key: str) -> Optional[dict]:
267 |         for storefront in data['storefronts']:
268 |             if storefront['name'] == key:
269 |                 return storefront
270 | 
271 |     def _create_store_items(self, data: dict) -> List[StoreItem]:
272 |         res = []
273 | 
274 |         for storefronts in ('BRWeeklyStorefront', 'BRDailyStorefront'):
275 |             storefront = self._find_storefront(data, storefronts)
276 |             for item in storefront['catalogEntries']:
277 |                 res.append(StoreItem(item))
278 | 
279 |         return res
280 | 


--------------------------------------------------------------------------------
/rebootpy/typedefs.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | """
 4 | MIT License
 5 | 
 6 | Copyright (c) 2019-2021 Terbau
 7 | 
 8 | Permission is hereby granted, free of charge, to any person obtaining a copy
 9 | of this software and associated documentation files (the "Software"), to deal
10 | in the Software without restriction, including without limitation the rights
11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 | copies of the Software, and to permit persons to whom the Software is
13 | furnished to do so, subject to the following conditions:
14 | 
15 | The above copyright notice and this permission notice shall be included in all
16 | copies or substantial portions of the Software.
17 | 
18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 | SOFTWARE.
25 | """
26 | 
27 | from datetime import datetime
28 | from typing import Union, Awaitable, Callable
29 | 
30 | 
31 | MaybeCoro = Union[Awaitable, Callable]
32 | StrOrMaybeCoro = Union[str, MaybeCoro]
33 | ListOrTuple = Union[list, tuple]
34 | StrOrInt = Union[str, int]
35 | DatetimeOrTimestamp = Union[datetime, int]
36 | 


--------------------------------------------------------------------------------
/rebootpy/utils.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2019-2021 Terbau
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | import asyncio
 28 | import datetime
 29 | import re
 30 | 
 31 | from typing import Optional
 32 | 
 33 | uuid_match_comp = re.compile(r'^[a-f0-9]{32}$')
 34 | 
 35 | 
 36 | class MaybeLock:
 37 |     def __init__(self, lock: asyncio.Lock,
 38 |                  loop: Optional[asyncio.AbstractEventLoop] = None) -> None:
 39 |         self.lock = lock
 40 |         self.loop = loop or asyncio.get_running_loop()
 41 |         self._cleanup = False
 42 | 
 43 |     async def _acquire(self) -> None:
 44 |         await self.lock.acquire()
 45 |         self._cleanup = True
 46 | 
 47 |     async def __aenter__(self) -> 'MaybeLock':
 48 |         self._task = self.loop.create_task(self._acquire())
 49 |         return self
 50 | 
 51 |     async def __aexit__(self, *args: list) -> None:
 52 |         if not self._task.cancelled():
 53 |             self._task.cancel()
 54 | 
 55 |         if self._cleanup:
 56 |             self.lock.release()
 57 | 
 58 | 
 59 | class LockEvent(asyncio.Lock):
 60 |     def __init__(self) -> None:
 61 |         super().__init__()
 62 | 
 63 |         self._event = asyncio.Event()
 64 |         self._event.set()
 65 |         self.wait = self._event.wait
 66 |         self.priority = 0
 67 | 
 68 |     async def acquire(self) -> None:
 69 |         await super().acquire()
 70 |         self._event.clear()
 71 | 
 72 |     def release(self) -> None:
 73 |         super().release()
 74 | 
 75 |         # Only set if no new acquire waiters exists. This is because we
 76 |         # don't want any wait()'s to return if there immediately will
 77 |         # be a new acquirer.
 78 |         if not (self._waiters is not None and [w for w in self._waiters
 79 |                                                if not w.cancelled()]):
 80 |             self._event.set()
 81 |             self.priority = 0
 82 | 
 83 | 
 84 | def from_iso(iso: str) -> datetime.datetime:
 85 |     """Converts an iso formatted string to a
 86 |     :class:`datetime.datetime` object
 87 | 
 88 |     Parameters
 89 |     ----------
 90 |     iso: :class:`str`:
 91 |         The iso formatted string to convert to a datetime object.
 92 | 
 93 |     Returns
 94 |     -------
 95 |     :class:`datetime.datetime`
 96 |     """
 97 |     if isinstance(iso, datetime.datetime):
 98 |         return iso
 99 | 
100 |     try:
101 |         return datetime.datetime.strptime(iso, '%Y-%m-%dT%H:%M:%S.%fZ')
102 |     except ValueError:
103 |         return datetime.datetime.strptime(iso, '%Y-%m-%dT%H:%M:%SZ')
104 | 
105 | 
106 | def to_iso(dt: datetime.datetime) -> str:
107 |     """Converts a :class:`datetime.datetime`
108 |     object to an iso formatted string
109 | 
110 |     Parameters
111 |     ----------
112 |     dt: :class:`datetime.datetime`
113 |         The datetime object to convert to an iso formatted string.
114 | 
115 |     Returns
116 |     -------
117 |     :class:`str`
118 |     """
119 |     iso = dt.strftime('%Y-%m-%dT%H:%M:%S.%f')
120 | 
121 |     # fortnite's services expect three digit precision on millis
122 |     return iso[:23] + 'Z'
123 | 
124 | 
125 | def is_id(value: str) -> bool:
126 |     """Simple function that finds out if a :class:`str` is a valid id to
127 |     use with fortnite services.
128 | 
129 |     Parameters
130 |     ----------
131 |     value: :class:`str`
132 |         The string you want to check.
133 | 
134 |     Returns
135 |     -------
136 |     :class:`bool`
137 |         ``True`` if string is valid else ``False``
138 |     """
139 |     return isinstance(value, str) and bool(uuid_match_comp.match(value))
140 | 
141 | 
142 | def is_display_name(value: str) -> bool:
143 |     """Simple function that finds out if a :class:`str` is a valid displayname
144 | 
145 |     Parameters
146 |     ----------
147 |     value: :class:`str`
148 |         The string you want to check.
149 | 
150 |     Returns
151 |     -------
152 |     :class:`bool`
153 |         ``True`` if string is valid else ``False``
154 |     """
155 |     return isinstance(value, str) and 3 <= len(value) <= 16
156 | 


--------------------------------------------------------------------------------
/rebootpy/websocket.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | """
  4 | MIT License
  5 | 
  6 | Copyright (c) 2024 Oli
  7 | 
  8 | Permission is hereby granted, free of charge, to any person obtaining a copy
  9 | of this software and associated documentation files (the "Software"), to deal
 10 | in the Software without restriction, including without limitation the rights
 11 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 12 | copies of the Software, and to permit persons to whom the Software is
 13 | furnished to do so, subject to the following conditions:
 14 | 
 15 | The above copyright notice and this permission notice shall be included in all
 16 | copies or substantial portions of the Software.
 17 | 
 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 21 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 22 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 23 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 24 | SOFTWARE.
 25 | """
 26 | 
 27 | import asyncio
 28 | import aiohttp
 29 | import json
 30 | import functools
 31 | import logging
 32 | 
 33 | from .message import FriendMessage, PartyMessage
 34 | 
 35 | from aiohttp import hdrs, helpers, client_reqrep, connector
 36 | from aiohttp.http import StreamWriter, HttpVersion10, HttpVersion11
 37 | 
 38 | log = logging.getLogger(__name__)
 39 | 
 40 | 
 41 | class WebsocketRequest(aiohttp.client_reqrep.ClientRequest):
 42 |     async def send(self,
 43 |                    conn: "aiohttp.connector.Connection"
 44 |                    ) -> "aiohttp.ClientResponse":
 45 |         if self.method == hdrs.METH_CONNECT:
 46 |             connect_host = self.url.raw_host
 47 |             assert connect_host is not None
 48 |             if helpers.is_ipv6_address(connect_host):
 49 |                 connect_host = f"[{connect_host}]"
 50 |             path = f"{connect_host}:{self.url.port}"
 51 |         elif self.proxy and not self.is_ssl():
 52 |             path = str(self.url)
 53 |         else:
 54 |             path = self.url.raw_path
 55 |             if self.url.raw_query_string:
 56 |                 path += "?" + self.url.raw_query_string
 57 | 
 58 |         protocol = conn.protocol
 59 |         assert protocol is not None
 60 |         writer = StreamWriter(
 61 |             protocol,
 62 |             self.loop,
 63 |             on_chunk_sent=functools.partial(
 64 |                 self._on_chunk_request_sent, self.method, self.url
 65 |             ),
 66 |             on_headers_sent=functools.partial(
 67 |                 self._on_headers_request_sent, self.method, self.url
 68 |             ),
 69 |         )
 70 | 
 71 |         if self.compress:
 72 |             writer.enable_compression(self.compress)
 73 | 
 74 |         if self.chunked is not None:
 75 |             writer.enable_chunking()
 76 | 
 77 |         if (
 78 |             self.method in self.POST_METHODS
 79 |             and hdrs.CONTENT_TYPE not in self.skip_auto_headers
 80 |             and hdrs.CONTENT_TYPE not in self.headers
 81 |         ):
 82 |             self.headers[hdrs.CONTENT_TYPE] = "application/octet-stream"
 83 | 
 84 |         connection = self.headers.get(hdrs.CONNECTION)
 85 |         if not connection:
 86 |             if self.keep_alive():
 87 |                 if self.version == HttpVersion10:
 88 |                     connection = "keep-alive"
 89 |             else:
 90 |                 if self.version == HttpVersion11:
 91 |                     connection = "close"
 92 | 
 93 |         if connection is not None:
 94 |             self.headers[hdrs.CONNECTION] = connection
 95 | 
 96 |         status_line = "{0} {1} HTTP/{2[0]}.{2[1]}".format(
 97 |             self.method, path, self.version
 98 |         ) if "/stomp" not in path else "GET https://connect.epicgames.dev/ " \
 99 |                                        "HTTP/1.1"
100 |         await writer.write_headers(status_line, self.headers)
101 | 
102 |         self._writer = self.loop.create_task(self.write_bytes(writer, conn, None))
103 | 
104 |         response_class = self.response_class
105 |         assert response_class is not None
106 |         self.response = response_class(
107 |             self.method,
108 |             self.original_url,
109 |             writer=self._writer,
110 |             continue100=self._continue,
111 |             timer=self._timer,
112 |             request_info=self.request_info,
113 |             traces=self._traces,
114 |             loop=self.loop,
115 |             session=self._session,
116 |         )
117 |         return self.response
118 | 
119 | 
120 | class WebsocketClient:
121 |     def __init__(self, client) -> None:
122 |         self.client = client
123 | 
124 |         self.wss_session = None
125 |         self.websocket = None
126 | 
127 |         self.heartbeat_started = False
128 | 
129 |     async def set_session(self) -> None:
130 |         self.wss_session = aiohttp.ClientSession(
131 |             skip_auto_headers=["Accept", "Accept-Encoding", "User-Agent"],
132 |             request_class=WebsocketRequest
133 |         )
134 | 
135 |     async def send_presence(self, connection_id: str) -> None:
136 |         await self.client.http.chat_send_presence(
137 |             connection_id=connection_id,
138 |             auth=f'bearer {self.client.auth.chat_access_token}'
139 |         )
140 | 
141 |     async def send_heartbeat(self, delay: int) -> None:
142 |         while not self.websocket.closed:
143 |             await self.websocket.send_str("\n")
144 |             await asyncio.sleep(delay)
145 | 
146 |     async def parse_message(self, raw: str) -> None:
147 |         raw_headers, raw_json = raw.split('\n\n', 1)
148 |         header_lines = raw_headers.splitlines()
149 |         message_type = header_lines[0]
150 | 
151 |         headers = {}
152 |         for line in header_lines[1:]:
153 |             key, value = line.split(':', 1)
154 |             headers[key.strip()] = value.strip()
155 | 
156 |         data = json.loads(raw_json[:-1]) if len(raw_json) >= 3 else {}
157 | 
158 |         log.debug(f'Received websocket message with type `{message_type}` '
159 |                   f'with the headers {headers}` and body \n{data}.')
160 | 
161 |         if message_type == 'CONNECTED' and not self.heartbeat_started:
162 |             self.heartbeat_started = True
163 | 
164 |             delay = int(headers['heart-beat'].split(',')[1]) // 1000
165 |             self.client.loop.create_task(self.send_heartbeat(delay))
166 | 
167 |             await self.websocket.send_str(f"SUBSCRIBE\nid:0\n"
168 |                                           f"destination:launcher\n\n\x00")
169 |         elif (message_type == 'MESSAGE' and 'type' in data
170 |               and data['type'] == 'core.connect.v1.connected'):
171 |             await self.send_presence(
172 |                 connection_id=data['connectionId']
173 |             )
174 |         elif (message_type == 'MESSAGE' and
175 |               'type' in data and
176 |               data['type'] == 'social.chat.v1.NEW_WHISPER'):
177 |             author = self.client.get_friend(
178 |                 data['payload']['message']['senderId']
179 |             )
180 |             if author is None:
181 |                 try:
182 |                     author = await self.client.wait_for(
183 |                         'friend_add',
184 |                         check=lambda f: f.id == data['payload']['message']
185 |                         ['senderId'],
186 |                         timeout=2
187 |                     )
188 |                 except asyncio.TimeoutError:
189 |                     return
190 | 
191 |             try:
192 |                 m = FriendMessage(
193 |                     client=self.client,
194 |                     author=author,
195 |                     content=data['payload']['message']['body']
196 |                 )
197 |                 self.client.dispatch_event('friend_message', m)
198 |             except ValueError:
199 |                 pass
200 |         elif (message_type == 'MESSAGE' and
201 |               'type' in data and
202 |               data['type'] == 'social.chat.v1.NEW_MESSAGE'):
203 |             user_id = data['payload']['message']['senderId']
204 |             party = self.client.party
205 | 
206 |             if (user_id == self.client.user.id
207 |                     or user_id not in party._members):
208 |                 return
209 | 
210 |             self.client.dispatch_event('party_message', PartyMessage(
211 |                 client=self.client,
212 |                 party=party,
213 |                 author=party._members[data['payload']['message']['senderId']],
214 |                 content=data['payload']['message']['body']
215 |             ))
216 | 
217 |     async def connect_to_websocket(self) -> None:
218 |         headers = {
219 |             'Authorization': f'Bearer {self.client.auth.chat_access_token}',
220 |             'Epic-Connect-Protocol': 'stomp',
221 |             "Sec-WebSocket-Protocol": "v10.stomp,v11.stomp,v12.stomp",
222 |             'Epic-Connect-Device-Id': " ",
223 |         }
224 |         async with self.wss_session.ws_connect(
225 |             "wss://connect.epicgames.dev/stomp",
226 |             protocols=['stomp'],
227 |             headers=headers
228 |         ) as websocket:
229 |             self.websocket = websocket
230 |             connect_frame = f"CONNECT\nheart-beat:30000,0\n" \
231 |                             f"accept-version:1.0,1.1,1.2\n\n\x00"
232 |             await websocket.send_str(connect_frame)
233 | 
234 |             async for msg in websocket:
235 |                 await self.parse_message(msg.data.decode())
236 | 
237 |     async def run(self) -> None:
238 |         await self.set_session()
239 |         self.client.loop.create_task(self.connect_to_websocket())
240 | 
241 |     async def close(self) -> None:
242 |         await self.websocket.close()
243 |         await self.wss_session.close()
244 | 
245 |         self.heartbeat_started = False
246 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | aiohttp>=3.10.10
2 | aioxmpp>=0.13.3
3 | aioconsole>=0.1.15
4 | pytz>=2024.2


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | import setuptools
 2 | import re
 3 | 
 4 | long_description = ''
 5 | with open("README.md", "r") as fh:
 6 |     long_description = fh.read()
 7 | 
 8 | version = ''
 9 | with open('rebootpy/__init__.py') as f:
10 |     version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE).group(1)
11 | 
12 | requirements = ['aiohttp>=3.10.10', 'aioxmpp>=0.13.3', 'aioconsole>=0.1.15', 'pytz>=2024.2']
13 | try:
14 |     with open('requirements.txt') as f:
15 |         requirements = f.read().splitlines()
16 | except FileNotFoundError:
17 |     pass
18 | 
19 | extras_require = {
20 |     'docs': [
21 |         'sphinxcontrib_trio==1.1.2',
22 |         'furo==2021.4.11b34',
23 |         'Jinja2<3.1',
24 |     ]
25 | }
26 | 
27 | setuptools.setup(
28 |     name="rebootpy",
29 |     url="https://github.com/xMistt/rebootpy",
30 |     project_urls={
31 |         "Documentation": "https://rebootpy.readthedocs.io/en/latest/",
32 |         "Issue tracker": "https://github.com/xMistt/rebootpy/issues",
33 |     },
34 |     version=version,
35 |     author="xMistt",
36 |     description="Library for interacting with fortnite services",
37 |     long_description=long_description,
38 |     license='MIT',
39 |     long_description_content_type="text/markdown",
40 |     install_requires=requirements,
41 |     extras_require=extras_require,
42 |     packages=['rebootpy', 'rebootpy.ext.commands'],
43 |     python_requires='>=3.7.0',
44 |     classifiers=[
45 |         'License :: OSI Approved :: MIT License',
46 |         'Intended Audience :: Developers',
47 |         'Natural Language :: English',
48 |         'Operating System :: OS Independent',
49 |         'Programming Language :: Python :: 3.7',
50 |         'Programming Language :: Python :: 3.8',
51 |         'Programming Language :: Python :: 3.9',
52 |         'Programming Language :: Python :: 3.10',
53 |         'Programming Language :: Python :: 3.11',
54 |         'Programming Language :: Python :: 3.12',
55 |         'Topic :: Internet',
56 |         'Topic :: Software Development :: Libraries',
57 |         'Topic :: Software Development :: Libraries :: Python Modules',
58 |         'Topic :: Utilities',
59 |     ],
60 | )
61 | 


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