pax_global_header00006660000000000000000000000064150754561120014520gustar00rootroot0000000000000052 comment=ebd10505dd733ed4df77391dcbf90d4bdaa7d45a Adafruit_CircuitPython_Typing-1.12.3/000077500000000000000000000000001507545611200175615ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/.gitattributes000066400000000000000000000003471507545611200224600ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense .py text eol=lf .rst text eol=lf .txt text eol=lf .yaml text eol=lf .toml text eol=lf .license text eol=lf .md text eol=lf Adafruit_CircuitPython_Typing-1.12.3/.github/000077500000000000000000000000001507545611200211215ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/.github/PULL_REQUEST_TEMPLATE/000077500000000000000000000000001507545611200244005ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md000066400000000000000000000015601507545611200322100ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2021 Adafruit Industries # # SPDX-License-Identifier: MIT Thank you for contributing! Before you submit a pull request, please read the following. Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. Adafruit_CircuitPython_Typing-1.12.3/.github/workflows/000077500000000000000000000000001507545611200231565ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/.github/workflows/build.yml000066400000000000000000000005271507545611200250040ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT name: Build CI on: [pull_request, push] jobs: test: runs-on: ubuntu-latest steps: - name: Run Build CI workflow uses: adafruit/workflows-circuitpython-libs/build@main with: ignore-bundles: mpy Adafruit_CircuitPython_Typing-1.12.3/.github/workflows/failure-help-text.yml000066400000000000000000000007371507545611200272470ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries # # SPDX-License-Identifier: MIT name: Failure help text on: workflow_run: workflows: ["Build CI"] types: - completed jobs: post-help: runs-on: ubuntu-latest if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} steps: - name: Post comment to help uses: adafruit/circuitpython-action-library-ci-failed@v1 Adafruit_CircuitPython_Typing-1.12.3/.github/workflows/release_gh.yml000066400000000000000000000007761507545611200260110ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT name: GitHub Release Actions on: release: types: [published] jobs: upload-release-assets: runs-on: ubuntu-latest steps: - name: Run GitHub Release CI workflow uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} upload-url: ${{ github.event.release.upload_url }} ignore-bundles: mpy Adafruit_CircuitPython_Typing-1.12.3/.github/workflows/release_pypi.yml000066400000000000000000000007331507545611200263650ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT name: PyPI Release Actions on: release: types: [published] jobs: upload-release-assets: runs-on: ubuntu-latest steps: - name: Run PyPI Release CI workflow uses: adafruit/workflows-circuitpython-libs/release-pypi@main with: pypi-username: ${{ secrets.pypi_username }} pypi-password: ${{ secrets.pypi_password }} Adafruit_CircuitPython_Typing-1.12.3/.gitignore000066400000000000000000000031661507545611200215570ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # # SPDX-License-Identifier: MIT # Do not include files and directories created by your personal work environment, such as the IDE # you use, except for those already listed here. Pull requests including changes to this file will # not be accepted. # This .gitignore file contains rules for files generated by working with CircuitPython libraries, # including building Sphinx, testing with pip, and creating a virual environment, as well as the # MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. # If you find that there are files being generated on your machine that should not be included in # your git commit, you should create a .gitignore_global file on your computer to include the # files created by your personal setup. To do so, follow the two steps below. # First, create a file called .gitignore_global somewhere convenient for you, and add rules for # the files you want to exclude from git commits. # Second, configure Git to use the exclude file for all Git repositories by running the # following via commandline, replacing "path/to/your/" with the actual path to your newly created # .gitignore_global file: # git config --global core.excludesfile path/to/your/.gitignore_global # CircuitPython-specific files *.mpy # Python-specific files __pycache__ *.pyc # Sphinx build-specific files _build # This file results from running `pip -e install .` in a local repository *.egg-info # Virtual environment-specific files .env .venv # MacOS-specific files *.DS_Store # IDE-specific files .idea .vscode *~ Adafruit_CircuitPython_Typing-1.12.3/.pre-commit-config.yaml000066400000000000000000000010111507545611200240330ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.3.4 hooks: - id: ruff-format - id: ruff args: ["--fix"] - repo: https://github.com/fsfe/reuse-tool rev: v3.0.1 hooks: - id: reuse Adafruit_CircuitPython_Typing-1.12.3/.readthedocs.yaml000066400000000000000000000007011507545611200230060ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries # # SPDX-License-Identifier: Unlicense # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 sphinx: configuration: docs/conf.py build: os: ubuntu-lts-latest tools: python: "3" python: install: - requirements: docs/requirements.txt - requirements: requirements.txt Adafruit_CircuitPython_Typing-1.12.3/CODE_OF_CONDUCT.md000066400000000000000000000151411507545611200223620ustar00rootroot00000000000000 # Adafruit Community Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and leaders pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level or type of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards We are committed to providing a friendly, safe and welcoming environment for all. Examples of behavior that contributes to creating a positive environment include: * Be kind and courteous to others * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Collaborating with other community members * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and sexual attention or advances * The use of inappropriate images, including in a community member's avatar * The use of inappropriate language, including in a community member's nickname * Any spamming, flaming, baiting or other attention-stealing behavior * Excessive or unwelcome helping; answering outside the scope of the question asked * Discussion or promotion of activities or projects that intend or pose a risk of significant harm * Trolling, insulting/derogatory comments, and personal or political attacks * Promoting or spreading disinformation, lies, or conspiracy theories against a person, group, organisation, project, or community * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be "technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for other community members can have a much more significant impact than simply providing the correct answer. ## Our Responsibilities Project leaders are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project leaders have the right and responsibility to remove, edit, or reject messages, comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any community member for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Moderation Instances of behaviors that violate the Adafruit Community Code of Conduct may be reported by any member of the community. Community members are encouraged to report these situations, including situations they witness involving other community members. You may report in the following ways: In any situation, you may email . On the Adafruit Discord, you may send an open message from any channel to all Community Moderators by tagging @community moderators. You may also send an open message from any channel, or a direct message to any Community Moderator. Email and direct message reports will be kept confidential. In situations on Discord where the issue is particularly offensive, possibly illegal, requires immediate action, or violates the Discord terms of service, you should also report the message directly to [Discord](https://discord.com/safety). These are the steps for upholding our community’s standards of conduct. 1. Any member of the community may report any situation that violates the CircuitPython Community Code of Conduct. All reports will be reviewed and investigated. 2. If the behavior is a severe violation, the community member who committed the violation may be banned immediately, without warning. 3. Otherwise, moderators will first respond to such behavior with a warning. 4. Moderators follow a soft "three strikes" policy - the community member may be given another chance, if they are receptive to the warning and change their behavior. 5. If the community member is unreceptive or unreasonable when warned by a moderator, or the warning goes unheeded, they may be banned for a first or second offense. Repeated offenses will result in the community member being banned. 6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply to the platform where the violation occurred. However, depending on the severity of the violation, the disciplinary action may be applied across Adafruit's other community platforms. For example, a severe violation on the Adafruit Discord server may result in a ban on not only the Adafruit Discord server, but also on the Adafruit GitHub organisation, Adafruit Forums, Adafruit Twitter, etc. ## Scope This Code of Conduct and the enforcement policies listed above apply to all Adafruit Community venues. This includes but is not limited to any community spaces (both public and private), the entire Adafruit Discord server, and Adafruit GitHub repositories. Examples of Adafruit Community spaces include but are not limited to meet-ups, audio chats on the Adafruit Discord, or interaction at a conference. This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. As a community member, you are representing our community, and are expected to behave accordingly. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html), and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). For other projects adopting the Adafruit Community Code of Conduct, please contact the maintainers of those projects for enforcement. If you wish to use this code of conduct for your own project, consider explicitly mentioning your moderation policy or making a copy with your own moderation policy so as to avoid confusion. Adafruit_CircuitPython_Typing-1.12.3/LICENSE000066400000000000000000000021161507545611200205660ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2022 Dan Halbert for Adafruit Industries Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Adafruit_CircuitPython_Typing-1.12.3/LICENSES/000077500000000000000000000000001507545611200207665ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/LICENSES/CC-BY-4.0.txt000066400000000000000000000406561507545611200226360ustar00rootroot00000000000000Creative Commons Attribution 4.0 International Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an "as-is" basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. Using Creative Commons Public Licenses Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor's permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. Section 1 – Definitions. a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. Section 2 – Scope. a. License grant. 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: A. reproduce and Share the Licensed Material, in whole or in part; and B. produce, reproduce, and Share Adapted Material. 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. 3. Term. The term of this Public License is specified in Section 6(a). 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. 5. Downstream recipients. A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). b. Other rights. 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. 2. Patent and trademark rights are not licensed under this Public License. 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. Section 3 – License Conditions. Your exercise of the Licensed Rights is expressly made subject to the following conditions. a. Attribution. 1. If You Share the Licensed Material (including in modified form), You must: A. retain the following if it is supplied by the Licensor with the Licensed Material: i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); ii. a copyright notice; iii. a notice that refers to this Public License; iv. a notice that refers to the disclaimer of warranties; v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. Section 4 – Sui Generis Database Rights. Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. Section 5 – Disclaimer of Warranties and Limitation of Liability. a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. Section 6 – Term and Termination. a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or 2. upon express reinstatement by the Licensor. c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. Section 7 – Other Terms and Conditions. a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. Section 8 – Interpretation. a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the "Licensor." The text of the Creative Commons public licenses is dedicated to the public domain under the CC0 Public Domain Dedication. Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark "Creative Commons" or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org. Adafruit_CircuitPython_Typing-1.12.3/LICENSES/MIT.txt000066400000000000000000000021241507545611200221570ustar00rootroot00000000000000MIT License Copyright (c) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Adafruit_CircuitPython_Typing-1.12.3/LICENSES/Unlicense.txt000066400000000000000000000022731507545611200234600ustar00rootroot00000000000000This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to Adafruit_CircuitPython_Typing-1.12.3/README.rst000066400000000000000000000044541507545611200212570ustar00rootroot00000000000000Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-typing/badge/?version=latest :target: https://docs.circuitpython.org/projects/adafruit-circuitpython-typing/en/latest/ :alt: Documentation Status .. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord .. image:: https://github.com/adafruit/Adafruit_CircuitPython_Typing/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/Adafruit_CircuitPython_Typing/actions :alt: Build Status .. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json :target: https://github.com/astral-sh/ruff :alt: Code Style: Ruff Definitions not in the standard `typing` module that are needed for type annotation of CircuitPython code. This library is not needed at runtime for CircuitPython code, and does not need to be in the bundle. Dependencies ============= Installing from PyPI ===================== On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI `_. To install for current user: .. code-block:: shell pip3 install adafruit-circuitpython-typing To install system-wide (this may be required in some cases): .. code-block:: shell sudo pip3 install adafruit-circuitpython-typing To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name python3 -m venv .venv source .venv/bin/activate pip3 install adafruit-circuitpython-typing Documentation ============= API documentation for this library can be found on `Read the Docs `_. For information on building library documentation, please check out `this guide `_. Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. Adafruit_CircuitPython_Typing-1.12.3/README.rst.license000066400000000000000000000002721507545611200226720ustar00rootroot00000000000000SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries SPDX-License-Identifier: MIT Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/000077500000000000000000000000001507545611200240575ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/__init__.py000066400000000000000000000076761507545611200262100ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries # # SPDX-License-Identifier: MIT """ `circuitpython_typing` ================================================================================ Types needed for type annotation that are not in `typing` * Author(s): Alec Delaney, Dan Halbert, Randy Hudson """ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Typing.git" import array from typing import TYPE_CHECKING, Optional, Union # Protocol was introduced in Python 3.8, TypeAlias in 3.10 from typing_extensions import Protocol, TypeAlias # pylint: disable=used-before-assignment if TYPE_CHECKING: import alarm import audiocore import audiomixer import audiomp3 import rgbmatrix import synthio import ulab from alarm.pin import PinAlarm from alarm.time import TimeAlarm from ulab.numpy import ndarray # Lists below are alphabetized. # More added in each conditional import. __all__ = [ "Alarm", "AudioSample", "BlockDevice", "ByteStream", "FrameBuffer", "ReadableBuffer", "WriteableBuffer", ] ReadableBuffer: TypeAlias = Union[ array.array, bytearray, bytes, memoryview, "rgbmatrix.RGBMatrix", "ulab.numpy.ndarray", ] """Classes that implement the readable buffer protocol.""" WriteableBuffer: TypeAlias = Union[ array.array, bytearray, memoryview, "rgbmatrix.RGBMatrix", "ulab.numpy.ndarray", ] """Classes that implement the writeable buffer protocol.""" class ByteStream(Protocol): """Protocol for basic I/O operations on a byte stream. Classes which implement this protocol include * `io.BytesIO` * `io.FileIO` (for a file open in binary mode) * `busio.UART` * `usb_cdc.Serial` """ def read(self, count: Optional[int] = None, /) -> Optional[bytes]: """Read ``count`` bytes from the stream. If ``count`` bytes are not immediately available, or if the parameter is not specified in the call, the outcome is implementation-dependent. """ def write(self, buf: ReadableBuffer, /) -> Optional[int]: """Write the bytes in ``buf`` to the stream.""" class BlockDevice(Protocol): """Protocol for block device objects to enable a device to support CircuitPython filesystems. Classes which implement this protocol include `storage.VfsFat`. """ def readblocks(self, start_block: int, buf: WriteableBuffer) -> None: """Read aligned, multiples of blocks. Starting at the block given by the index ``start_block``, read blocks from the device into ``buf``. The number of blocks to read is given by the length of ``buf``, which will be a multiple of the block size. """ def writeblocks(self, start_block: int, buf: ReadableBuffer) -> None: """Write aligned, multiples of blocks, and require that the blocks that are written to be first erased (if necessary) by this method. Starting at the block given by the index ``start_block``, write blocks from ``buf`` to the device. The number of blocks to write is given by the length of ``buf``, which will be a multiple of the block size. """ # These types may not be in adafruit-blinka, so use the string form instead of a resolved name. AudioSample: TypeAlias = Union[ "audiocore.WaveFile", "audiocore.RawSample", "audiomixer.Mixer", "audiomp3.MP3Decoder", "synthio.MidiTrack", ] """Classes that implement the audiosample protocol. You can play these back with `audioio.AudioOut`, `audiobusio.I2SOut` or `audiopwmio.PWMAudioOut`. """ FrameBuffer: TypeAlias = Union["rgbmatrix.RGBMatrix"] """Classes that implement the framebuffer protocol.""" Alarm: TypeAlias = Union["alarm.pin.PinAlarm", "alarm.time.TimeAlarm"] """Classes that implement alarms for sleeping and asynchronous notification. You can use these alarms to wake up from light or deep sleep. """ Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/device_drivers.py000066400000000000000000000015101507545611200274230ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # SPDX-License-Identifier: MIT """ `circuitpython_typing.device_drivers` ================================================================================ Type annotation definitions for device drivers. Used for `adafruit_register`. * Author(s): Alec Delaney """ from adafruit_bus_device.i2c_device import I2CDevice from adafruit_bus_device.spi_device import SPIDevice from typing_extensions import Protocol # Safety import for Python 3.7 # pylint: disable=too-few-public-methods class I2CDeviceDriver(Protocol): """Describes classes that are drivers utilizing `I2CDevice`""" i2c_device: I2CDevice # pylint: disable=too-few-public-methods class SPIDeviceDriver(Protocol): """Describes classes that are drivers utilizing `SPIDevice`""" spi_device: SPIDevice Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/displayio.py000066400000000000000000000010251507545611200264240ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2025 Tim Cocks for Adafruit Industries # # SPDX-License-Identifier: MIT """ `circuitpython_typing.displayio` ================================================================================ Type annotation definitions used for displayio related components. * Author(s): Tim Cocks """ from typing import TypeAlias, Union from busdisplay import BusDisplay from epaperdisplay import EPaperDisplay AnyDisplay: TypeAlias = Union[BusDisplay, EPaperDisplay, "framebufferio.FramebufferDisplay"] Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/http.py000066400000000000000000000016031507545611200254100ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # # SPDX-License-Identifier: MIT """ `circuitpython_typing.http` =========================== Type annotation definitions for HTTP and related objects * Author(s): Alec Delaney """ from adafruit_requests import Response # Protocol was introduced in Python 3.8. from typing_extensions import Protocol class HTTPProtocol(Protocol): """Protocol for HTTP request managers, like typical wifi managers""" def get(self, url: str, **kw) -> Response: """Send HTTP GET request""" def put(self, url: str, **kw) -> Response: """Send HTTP PUT request""" def post(self, url: str, **kw) -> Response: """Send HTTP POST request""" def patch(self, url: str, **kw) -> Response: """Send HTTP PATCH request""" def delete(self, url: str, **kw) -> Response: """Send HTTP DELETE request""" Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/io.py000066400000000000000000000021341507545611200250400ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # # SPDX-License-Identifier: MIT """ `circuitpython_typing.io` ================================================================================ Type annotation definitions for IO-related objects * Author(s): Alec Delaney """ # Protocol was introduced in Python 3.8. from typing_extensions import Protocol class ROValueIO(Protocol): """Hardware objects, like `analogio.AnalogIn`, that have read-only ``value`` properties/attributes. """ @property def value(self) -> float: """Value property, that may return an `int` or `float` depending on the specifics of the class. """ class ValueIO(Protocol): """Hardware objects, like `analogio.AnalogOut`, that have read and write ``value`` properties/attributes. """ @property def value(self) -> float: """Value property, that may return an `int` or `float` depending on the specifics of the class. """ # pylint: disable=no-self-use,unused-argument @value.setter def value(self, input_value: float, /): ... Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/led.py000066400000000000000000000016671507545611200252070ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # # SPDX-License-Identifier: MIT """ `circuitpython_typing.led` ================================================================================ Type annotation definitions for LEDs. * Author(s): Alec Delaney """ from typing import Tuple, Union # Protocol was introduced in Python 3.8, TypeAlias in 3.10 from typing_extensions import Protocol, TypeAlias ColorBasedColorUnion: TypeAlias = Union[int, Tuple[int, int, int]] FillBasedColorUnion: TypeAlias = Union[ColorBasedColorUnion, Tuple[int, int, int, int]] class ColorBasedLED(Protocol): """Protocol for LEDs using the :meth:`color` method""" def color(self, value: ColorBasedColorUnion) -> None: """Sets the color of the LED""" class FillBasedLED(Protocol): """Protocol for LEDs using the :meth:`fill` method""" def fill(self, color: FillBasedColorUnion) -> None: """Sets the color of the LED""" Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/pil.py000066400000000000000000000030441507545611200252160ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # # SPDX-License-Identifier: MIT """ `circuitpython_typing.pil` ================================================================================ Type annotation definitions for PIL Images. * Author(s): Alec Delaney """ from typing import Callable, Optional, Tuple # Protocol was introduced in Python 3.8 from typing_extensions import Protocol class PixelAccess(Protocol): """Type annotation for PIL's PixelAccess class""" # pylint: disable=invalid-name def __getitem__(self, xy: Tuple[int, int]) -> int: """Get pixels by x, y coordinate""" class Image(Protocol): """Type annotation for PIL's Image class""" # pylint: disable=too-many-arguments,invalid-name @property def mode(self) -> str: """The mode of the image""" @property def size(self) -> Tuple[int, int]: """The size of the image""" def load(self) -> PixelAccess: """Load the image for quick pixel access""" def convert( self, mode: str, matrix: Optional[Tuple], dither: Callable, palette: int, colors: int, ): """Returns a converted copy of this image.""" def rotate( self, angle: int, resampling, expand: int, center: Tuple[int, int], translate: Tuple[int, int], fillcolor: int, ): """Returns a rotated copy of this image.""" def getpixel(self, xy: Tuple[int, int]): """Returns the pixel value at a given position.""" Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/pwmio.py000066400000000000000000000013461507545611200255700ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Alec Delaney # # SPDX-License-Identifier: MIT """ `circuitpython_typing.pwmio` ================================================================================ Type annotation definitions for PWMOut where Blinka doesn't otherwise define it. * Author(s): Alec Delaney """ # # Protocol was introduced in Python 3.8. from typing_extensions import Protocol class PWMOut(Protocol): """Protocol that implements, at the bare minimum, the `duty_cycle` property""" @property def duty_cycle(self) -> int: """The duty cycle as a ratio using 16-bits""" # pylint: disable=no-self-use,unused-argument @duty_cycle.setter def duty_cycle(self, duty_cycle: int) -> None: ... Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/py.typed000066400000000000000000000000001507545611200255440ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/circuitpython_typing/socket.py000066400000000000000000000113061507545611200257220ustar00rootroot00000000000000# SPDX-FileCopyrightText: Copyright (c) 2022 Kevin Conley # SPDX-License-Identifier: MIT """ `circuitpython_typing.socket` ================================================================================ Type annotation definitions for sockets. Used for `adafruit_requests` and similar libraries. * Author(s): Kevin Conley """ from ssl import SSLContext from types import ModuleType from typing import Any, Optional, Tuple, Union # Protocol was introduced in Python 3.8, TypeAlias in 3.10 from typing_extensions import Protocol, TypeAlias # Based on https://github.com/python/typeshed/blob/master/stdlib/_socket.pyi __all__ = [ # alphabetized "CircuitPythonSocketType", "CommonCircuitPythonSocketType", "CommonSocketType", "InterfaceType", "LegacyCircuitPythonSocketType", "SSLContextType", "SocketType", "SocketpoolModuleType", "StandardPythonSocketType", "SupportsRecvInto", "SupportsRecvWithFlags", ] class CommonSocketType(Protocol): """Describes the common structure every socket type must have.""" def send(self, data: bytes, flags: int = ...) -> None: """Send data to the socket. The meaning of the optional flags kwarg is implementation-specific.""" def settimeout(self, value: Optional[float]) -> None: """Set a timeout on blocking socket operations.""" def close(self) -> None: """Close the socket.""" class CommonCircuitPythonSocketType(CommonSocketType, Protocol): """Describes the common structure every CircuitPython socket type must have.""" def connect( self, address: Tuple[str, int], conntype: Optional[int] = ..., ) -> None: """Connect to a remote socket at the provided (host, port) address. The conntype kwarg optionally may indicate SSL or not, depending on the underlying interface. """ class LegacyCircuitPythonSocketType(CommonCircuitPythonSocketType, Protocol): """Describes the structure a legacy CircuitPython socket type must have.""" def recv(self, bufsize: int = ...) -> bytes: """Receive data from the socket. The return value is a bytes object representing the data received. The maximum amount of data to be received at once is specified by bufsize.""" class SupportsRecvWithFlags(Protocol): """Describes a type that posseses a socket recv() method supporting the flags kwarg.""" def recv(self, bufsize: int = ..., flags: int = ...) -> bytes: """Receive data from the socket. The return value is a bytes object representing the data received. The maximum amount of data to be received at once is specified by bufsize. The meaning of the optional flags kwarg is implementation-specific. """ class SupportsRecvInto(Protocol): """Describes a type that possesses a socket recv_into() method.""" def recv_into(self, buffer: bytearray, nbytes: int = ..., flags: int = ...) -> int: """Receive up to nbytes bytes from the socket, storing the data into the provided buffer. If nbytes is not specified (or 0), receive up to the size available in the given buffer. The meaning of the optional flags kwarg is implementation-specific. Returns the number of bytes received.""" class CircuitPythonSocketType( CommonCircuitPythonSocketType, SupportsRecvInto, SupportsRecvWithFlags, Protocol, ): # pylint: disable=too-many-ancestors """Describes the structure every modern CircuitPython socket type must have.""" class StandardPythonSocketType(CommonSocketType, SupportsRecvInto, SupportsRecvWithFlags, Protocol): """Describes the structure every standard Python socket type must have.""" def connect(self, address: Union[Tuple[Any, ...], str, bytes]) -> None: """Connect to a remote socket at the provided address.""" SocketType: TypeAlias = Union[ LegacyCircuitPythonSocketType, CircuitPythonSocketType, StandardPythonSocketType, ] SocketpoolModuleType = ModuleType class InterfaceType(Protocol): """Describes the structure every interface type must have.""" @property def TLS_MODE(self) -> int: # pylint: disable=invalid-name """Constant representing that a socket's connection mode is TLS.""" # pylint: disable=too-few-public-methods class _FakeSSLSocket: """Describes the structure every fake SSL socket type must have.""" class _FakeSSLContext: """Describes the structure every fake SSL context type must have.""" def wrap_socket( self, socket: CircuitPythonSocketType, server_hostname: Optional[str] = None ) -> _FakeSSLSocket: """Wrap socket and return a new one that uses the methods from the original.""" SSLContextType: TypeAlias = Union[SSLContext, _FakeSSLContext] Adafruit_CircuitPython_Typing-1.12.3/docs/000077500000000000000000000000001507545611200205115ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/docs/_static/000077500000000000000000000000001507545611200221375ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/docs/_static/custom.css000066400000000000000000000004141507545611200241620ustar00rootroot00000000000000/* SPDX-FileCopyrightText: 2025 Sam Blenny * SPDX-License-Identifier: MIT */ /* Monkey patch the rtd theme to prevent horizontal stacking of short items * see https://github.com/readthedocs/sphinx_rtd_theme/issues/1301 */ .py.property{display: block !important;} Adafruit_CircuitPython_Typing-1.12.3/docs/_static/favicon.ico000066400000000000000000000104761507545611200242700ustar00rootroot00000000000000  (( @ 'w",h&PƆ(ׄ)hP8  ":60/M1S*( a$4 0  UzX̓[:fۏ/e/e,_) +_.IYYr A6"Lŵ[f S ȋ%ӏ/e/e-a! {U%ɂJΉP݋\8KK_(BɂM+ 5 '̏/e/e/e8'*[/e/e/e/e/e/e/e1d/e.mvOЫF= W*M$7/f/e0-?Σ9re0d/e/d)/e/e/e/e/e/e/e/e/e/e/e/e/ewI$2!/e/e,B/e/ez(V2E=6-E+ :674 B5.H3Ã+]/e/e/e/e/e(},B e"H/%# &XRp^/e/ei#K^ ΍_FˋFˁEs.#o%N׏/e/e/e/e2 Y+H-/e/eo%NZS2qگ\UŎ+y?jӧOcĎ#˺j`1cIxU;Ə/e/e-_  3yJ6( ŏ/e/e~*Z9(s%Rl$Mu&R݁+Z/d/e/e/e0deVF+&~*Xm%Mzu'TH3`+UX́[>]/e/e VhS c-V?k/M<19-*Z/e/eA_TVQf!)(>+r/e/e8Yq̈Nǎ߻g}IPB3/e/eH8'" 8+~ =/e/eB0+^/e/e/e2dXZċbHx6',^+  >1E̹bz/e/ey)V 1"g"Iҏ/e/e/e/eeNCl5 ,m/e/e L :(e"Hk#L<* j"FNTvR/e/e6&GQǏ/e/e|(Wj1Izċ+u/e/e Z~M/e/eH3&GT /e/e-_,o/e/e/e#  p,^/e/e/eQ:/ aNq%Pڏ/e/e/e-_v M3^.c/e/e/e/e$IHz'& $p%O܏/e/e/e/e/e/e' Gb E݂+\-_r%P,]/e/e/e/e/e2#P96'/e/e/ez=A_C͇-_/e/e/e6' r%P.c/e/e}+YiU!۱f(~*Z/e &! w'Sj#KԿٹw'Sߏ/e+\ q&Pu(Sd5Om$Nҏ/e+^y0"[@U<0!   3,Adafruit_CircuitPython_Typing-1.12.3/docs/_static/favicon.ico.license000066400000000000000000000001511507545611200256760ustar00rootroot00000000000000SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries SPDX-License-Identifier: CC-BY-4.0 Adafruit_CircuitPython_Typing-1.12.3/docs/api.rst000066400000000000000000000005121507545611200220120ustar00rootroot00000000000000 .. If you created a package, create one automodule per module in the package. .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" .. automodule:: circuitpython_typing :members: .. automodule:: circuitpython_typing.socket :members: Adafruit_CircuitPython_Typing-1.12.3/docs/api.rst.license000066400000000000000000000002731507545611200234370ustar00rootroot00000000000000SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries SPDX-License-Identifier: MIT Adafruit_CircuitPython_Typing-1.12.3/docs/conf.py000066400000000000000000000132731507545611200220160ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT import datetime import os import sys sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ "sphinx.ext.autodoc", "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", ] # TODO: Please Read! # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. # autodoc_mock_imports = ["digitalio", "busio"] intersphinx_mapping = { "python": ("https://docs.python.org/3", None), "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), "Adafruit_CircuitPython_Requests": ( "https://docs.circuitpython.org/projects/requests/en/latest/", None, ), } # Show the docstring from both the class and its __init__() method. autoclass_content = "both" # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] source_suffix = ".rst" # The master toctree document. master_doc = "index" # General information about the project. project = "Adafruit CircuitPython circuitpython_typing Library" creation_year = "2022" current_year = str(datetime.datetime.now().year) year_duration = ( current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Dan Halbert" author = "Dan Halbert" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = "1.0" # The full version, including alpha/beta/rc tags. release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path exclude_patterns = [ "_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md", ] # The reST default role (used for this markup: `text`) to use for all # documents. # default_role = "any" # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # If this is True, todo emits a warning for each TODO entries. The default is False. todo_emit_warnings = True napoleon_numpy_docstring = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] # Include extra css to work around rtd theme glitches html_css_files = ["custom.css"] # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. htmlhelp_basename = "Adafruit_CircuitPython_Typing_Librarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', # Latex figure (float) alignment # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ ( master_doc, "Adafruit_CircuitPython_Typing_Library.tex", "Adafruit CircuitPython circuitpython_typing Library Documentation", author, "manual", ), ] # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ( master_doc, "Adafruit_CircuitPython_Typing_Library", "Adafruit CircuitPython circuitpython_typing Library Documentation", [author], 1, ), ] # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( master_doc, "Adafruit_CircuitPython_Typing_Library", "Adafruit CircuitPython circuitpython_typing Library Documentation", author, "Adafruit_CircuitPython_Typing_Library", "One line description of project.", "Miscellaneous", ), ] Adafruit_CircuitPython_Typing-1.12.3/docs/examples.rst000066400000000000000000000002721507545611200230620ustar00rootroot00000000000000Simple test ------------ Ensure your device works with this simple test. .. literalinclude:: ../examples/typing_simpletest.py :caption: examples/typing_simpletest.py :linenos: Adafruit_CircuitPython_Typing-1.12.3/docs/examples.rst.license000066400000000000000000000002731507545611200245040ustar00rootroot00000000000000SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries SPDX-License-Identifier: MIT Adafruit_CircuitPython_Typing-1.12.3/docs/index.rst000066400000000000000000000017141507545611200223550ustar00rootroot00000000000000 .. include:: ../README.rst Table of Contents ================= .. toctree:: :maxdepth: 4 :hidden: self .. toctree:: :caption: Examples examples .. toctree:: :caption: API Reference :maxdepth: 3 api .. toctree:: :caption: Tutorials .. toctree:: :caption: Related Products .. toctree:: :caption: Other Links Download from GitHub Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System Adafruit Blog Adafruit Store Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` Adafruit_CircuitPython_Typing-1.12.3/docs/index.rst.license000066400000000000000000000002731507545611200237750ustar00rootroot00000000000000SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries SPDX-License-Identifier: MIT Adafruit_CircuitPython_Typing-1.12.3/docs/requirements.txt000066400000000000000000000002321507545611200237720ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries # # SPDX-License-Identifier: Unlicense sphinx sphinxcontrib-jquery sphinx-rtd-theme Adafruit_CircuitPython_Typing-1.12.3/examples/000077500000000000000000000000001507545611200213775ustar00rootroot00000000000000Adafruit_CircuitPython_Typing-1.12.3/examples/typing_simpletest.py000066400000000000000000000003101507545611200255260ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit_CircuitPython_Typing-1.12.3/optional_requirements.txt000066400000000000000000000001541507545611200247520ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit_CircuitPython_Typing-1.12.3/pyproject.toml000066400000000000000000000023161507545611200224770ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries # # SPDX-License-Identifier: MIT [build-system] requires = [ "setuptools", "wheel", "setuptools-scm", ] [project] name = "adafruit-circuitpython-typing" description = "Types needed for type annotation that are not in `typing`" version = "0.0.0+auto.0" requires-python = ">=3.8" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} ] urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_Typing"} keywords = [ "adafruit", "blinka", "circuitpython", "micropython", "circuitpython_typing", ] license = {text = "MIT"} classifiers = [ "Intended Audience :: Developers", "Topic :: Software Development :: Libraries", "Topic :: Software Development :: Embedded Systems", "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", ] dynamic = ["dependencies", "optional-dependencies"] [tool.setuptools] packages = ["circuitpython_typing"] [tool.setuptools.dynamic] dependencies = {file = ["requirements.txt"]} optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} Adafruit_CircuitPython_Typing-1.12.3/requirements.txt000066400000000000000000000004531507545611200230470ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # SPDX-FileCopyrightText: Copyright (c) 2022 Dan Halbert for Adafruit Industries # # SPDX-License-Identifier: MIT Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-requests typing_extensions~=4.0 Adafruit_CircuitPython_Typing-1.12.3/ruff.toml000066400000000000000000000057201507545611200214240ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries # # SPDX-License-Identifier: MIT target-version = "py38" line-length = 100 [lint] preview = true select = ["I", "PL", "UP"] extend-select = [ "D419", # empty-docstring "E501", # line-too-long "W291", # trailing-whitespace "PLC0414", # useless-import-alias "PLC2401", # non-ascii-name "PLC2801", # unnecessary-dunder-call "PLC3002", # unnecessary-direct-lambda-call "PLE0101", # return-in-init "F706", # return-outside-function "F704", # yield-outside-function "PLE0116", # continue-in-finally "PLE0117", # nonlocal-without-binding "PLE0241", # duplicate-bases "PLE0302", # unexpected-special-method-signature "PLE0604", # invalid-all-object "PLE0605", # invalid-all-format "PLE0643", # potential-index-error "PLE0704", # misplaced-bare-raise "PLE1141", # dict-iter-missing-items "PLE1142", # await-outside-async "PLE1205", # logging-too-many-args "PLE1206", # logging-too-few-args "PLE1307", # bad-string-format-type "PLE1310", # bad-str-strip-call "PLE1507", # invalid-envvar-value "PLE2502", # bidirectional-unicode "PLE2510", # invalid-character-backspace "PLE2512", # invalid-character-sub "PLE2513", # invalid-character-esc "PLE2514", # invalid-character-nul "PLE2515", # invalid-character-zero-width-space "PLR0124", # comparison-with-itself "PLR0202", # no-classmethod-decorator "PLR0203", # no-staticmethod-decorator "UP004", # useless-object-inheritance "PLR0206", # property-with-parameters "PLR0904", # too-many-public-methods "PLR0911", # too-many-return-statements "PLR0916", # too-many-boolean-expressions "PLR1702", # too-many-nested-blocks "PLR1704", # redefined-argument-from-local "PLR1711", # useless-return "C416", # unnecessary-comprehension "PLR1733", # unnecessary-dict-index-lookup "PLR1736", # unnecessary-list-index-lookup # ruff reports this rule is unstable #"PLR6301", # no-self-use "PLW0108", # unnecessary-lambda "PLW0120", # useless-else-on-loop "PLW0127", # self-assigning-variable "PLW0129", # assert-on-string-literal "B033", # duplicate-value "PLW0131", # named-expr-without-context "PLW0245", # super-without-brackets "PLW0406", # import-self "PLW0602", # global-variable-not-assigned "PLW0603", # global-statement "PLW0604", # global-at-module-level # fails on the try: import typing used by libraries #"F401", # unused-import "F841", # unused-variable "E722", # bare-except "PLW0711", # binary-op-exception "PLW1501", # bad-open-mode "PLW1508", # invalid-envvar-default "PLW1509", # subprocess-popen-preexec-fn "PLW2101", # useless-with-lock "PLW3301", # nested-min-max ] ignore = [ "PLR2004", # magic-value-comparison "UP030", # format literals "PLW1514", # unspecified-encoding "PLR0913", # too-many-arguments "PLR0917", # too-many-positional-arguments ] [format] line-ending = "lf"