diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..e7e9d4b --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,12 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: ['https://github.com/sponsors/Franck1333'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml new file mode 100644 index 0000000..8573636 --- /dev/null +++ b/.github/workflows/python-app.yml @@ -0,0 +1,39 @@ +# This workflow will install Python dependencies, run tests and lint with a single version of Python +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: FR_Template + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +permissions: + contents: read + +jobs: + build: + + runs-on: debian-latest , windows-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.11 + uses: actions/setup-python@v3 + with: + python-version: "3.11" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml new file mode 100644 index 0000000..d0f5f9f --- /dev/null +++ b/.github/workflows/python-package.yml @@ -0,0 +1,40 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: FR_Template_package + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + build: + + runs-on: debian-latest, windows-latest + strategy: + fail-fast: false + matrix: + python-version: ["3.9", "3.10", "3.11"] + + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest diff --git a/.github/workflows/qodana_code_quality.yml b/.github/workflows/qodana_code_quality.yml new file mode 100644 index 0000000..b100ea7 --- /dev/null +++ b/.github/workflows/qodana_code_quality.yml @@ -0,0 +1,21 @@ +name: Qodana +on: + workflow_dispatch: + pull_request: + push: + branches: + - master + +jobs: + qodana: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: 'Qodana Scan' + uses: JetBrains/qodana-action@v2024.1 + env: + QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }} + with: + args: --baseline,qodana.sarif.json \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/.idea/.name b/.idea/.name new file mode 100644 index 0000000..42061c0 --- /dev/null +++ b/.idea/.name @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/.idea/FR_Template.iml b/.idea/FR_Template.iml new file mode 100644 index 0000000..ef17271 --- /dev/null +++ b/.idea/FR_Template.iml @@ -0,0 +1,14 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..41b6f35 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,26 @@ + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..a44514f --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..e122ec3 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml new file mode 100644 index 0000000..a19003f --- /dev/null +++ b/.idea/workspace.xml @@ -0,0 +1,172 @@ + + + + + + + + + + + + + + + + + + + + + + + + { + "associatedIndex": 4 +} + + + + { + "keyToString": { + "ASKED_ADD_EXTERNAL_FILES": "true", + "Python.Interface_Tkinter_Template.executor": "Run", + "RunOnceActivity.ShowReadmeOnStart": "true", + "git-widget-placeholder": "master", + "ignore.virus.scanning.warn.message": "true", + "last_opened_file_path": "D:/OneDrive/Documents/Projets/Projet GITHUB/FR_Template", + "settings.editor.selected.configurable": "com.jetbrains.python.configuration.PyActiveSdkModuleConfigurable" + } +} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1718311686787 + + + + + + + + + + + file://$PROJECT_DIR$/Services/Exemple_Services/Infos_Hardware.py + 11 + + + + + \ No newline at end of file diff --git a/3D_Model/Cool Kieran-Krunk.stl b/3D_Model/Cool Kieran-Krunk.stl new file mode 100644 index 0000000..ba3b864 Binary files /dev/null and b/3D_Model/Cool Kieran-Krunk.stl differ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..becee67 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* 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 unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* 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 in a + professional setting + +## Our Responsibilities + +Project maintainers 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 maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at fun13@live.fr. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8455cb7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +You're a not a good boy if you are a bad boy, +C'est pas bien d'être méchant , c'est mieux d'être gentil. +Ok Boomer. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..32022ab --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +# FR_Template + +This Software allow you to get financials informations about cryptocurrencies by using Python3 and the UI that will let you interact to the software with a modern graphic user interface. + +[![Image](https://alternative.me/crypto/fear-and-greed-index.png)](https://alternative.me/crypto/fear-and-greed-index.png) + +## Getting Started + +To get a copy of the project, you can go on the GitHub's webpage of the project and click on the green button to download as a .ZIP file. However, if you're using a prompt console on an Unix machine use this line : + +``` +git clone https://github.com/Franck1333/FR_Template.git +``` + +### Prerequisites + +To use the project, you will need some Hardware : + +``` +A Raspberry Pi (Last Version is better) or any Linux computer compatible, +An Internet Connection, +A Micro S.D card (8 Gb Minimum), +A Display (like the Pimoroni 4inch HyperPixel Display --> https://bit.ly/2FVOy5j). +``` + And you will also need some libraries and softwares : + +``` +- Python version 3 +- An OS up to date +``` + +Be sure to be Up to date with your OS and Python3 environement with this command line: +``` +- sudo apt update -y && sudo apt-get update && sudo apt-get upgrade && sudo pip3 install --upgrade pip +``` + +You can install the *Pimoroni HyperPixel 4* like this : +``` +- The Github page : https://github.com/pimoroni/hyperpixel4 +- The command line Setup (need to be install) : https://get.pimoroni.com/hyperpixel4 | bash +``` + +### Downloading/Installing +To get and downloaded the files, use this line : +``` +git clone https://github.com/Franck1333/FR_Template.git +``` +When the project is Downloaded, check your `pi` folder, and you will see the folder `FR_Template` . + +When you did it, you will have to launch the file called `setup.py` to install the dependencies neccessary for the project with this command line : + +``` + sudo python3 setup.py install +``` + +There is another way to install all the dependencies needed: + + sudo pip3 install -r requirements.txt + +If some problem during the installation occured, please execute this command : +``` + sudo pip3 install cbpro cmc pandas numpy matplotlib pydub kivy cython + sudo apt-get install idle3 +``` + +## Run +#### The Way to run the project : +To run the project; if you want to see the console activities, you can launch the file called `Main.py` into the Command Line Prompt with `python3 Main.py` in the main folder. + +## Running the tests + +That's how to test features: + + python3 .py + +## The Folders and Files + +In this project we've got some folders + +#### Folders +``` +Example : Any help or example that I used for the project +Services: Main features +``` +#### Files in "/CryptoWatch-Tkinter/Services/" + +Main features of the program +``` +- Info_Hardware.py: This feature allow to the Main program to get informations about the status of processors(Usage,Temp),RAM(Usage). + +- nettoyage_du_cache.py: Ancient program that allow all the program which using to delete all the Python2 Cache Files. +``` + +Folders inside + ``` + - Sounds: Sound Pack use by the Main Program + - Téléchargements: This folder is use by the Main Program to download in this folder all the ressources which come from Internet + ``` + +## Authors + +- **Franck ROCHAT** - _Initial work_ - [Franck ROCHAT](https://github.com/Franck1333) Thank You ! :heart: + +[![Image](https://i.goopics.net/51JA2.jpg)](https://goopics.net/i/51JA2) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..034e848 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc. diff --git a/Services/Exemple_Services/Check_Validite.py b/Services/Exemple_Services/Check_Validite.py new file mode 100644 index 0000000..c6dbc8c --- /dev/null +++ b/Services/Exemple_Services/Check_Validite.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- + +import serial +import time +import os +import sys + +from Recuperation_Determination import * +from Recuperation_Determination import parse_GPRMC +#from Recuperation_Determination import ouverture_serie +from Recuperation_Determination import lecture_return_serie + +try : + from Tkinter import * #Python Version 2 + pass +except: + from tkinter import * #Python Version 3 + + +fenetre = Tk() + + +def GPS_test(): + + #while 1: #Boucle infinie de Démonstration + + Decimal_latitude,Decimal_longitude,Validite,Latitude_Hemisphere,Longitude_Hemisphere, = lecture_return_serie() #Récuperation des variables depuis le fichier Python "Recuperation_Determination" + + + #Validite = "V" #Valeur de TEST + + global GPS + global GPSErreur + + if Validite == "V": + + GPSErreur = Toplevel() + + Label_Annonce_GPSErreur = Label(GPSErreur,text="Malheureusement, Nous ne captons pas correctement le Signal G.P.S , déplacez vous ;=)").pack() + + Label_ShowValue_GPSErreur = Label(GPSErreur, text=Validite).pack() + + print("La Trame recu n'est pas Valide // Validite = V :", Validite) + + Button(GPSErreur, text="Fermer", command=GPSErreur.destroy).pack() + + + else : #if Validite == "A": + GPS=Toplevel() + + Label_Annonce_GPS = Label(GPS,text="Nous captons correctement le Signal GPS, le Programme pourras continuer comme prévue").pack() + + Label_ShowValue_GPS = Label(GPS,text=Validite).pack() + + print("La Trame recu est Valide // Validite = A :", Validite) + + Button(GPS, text="Fermer", command=GPS.destroy).pack() + +Button(fenetre, text="G.P.S_test", command=GPS_test).pack() +Button(fenetre, text="Fermer...", command=fenetre.quit).pack() + + +fenetre.mainloop() + + + +#Ce petit programme permet de Tester la Validite d'une Trame GPS reçue est de savoir si elle est Accpeter ou Refuser +#Dans le cas ou elle serait Refuser, Une fenêtre dédiée s'ouvrira et indiquera que le Signal GPS reçue n'est pas Bon. +#Dans le cas contraire , Une Fenêtre tkinter dédiée s'ouvrira à son tour pour indiquer que le Signal GPS est Accepter et que le Programme continue son éxécution. + + + + + #Par ce petit programme, je montre comment récupere les valeurs GPS de manière plus proche de la source qu'auparavant de cette manière en utilisant la Fonction "lecture_return_serie()" définie dans Recuperation_Determination.py . + + #-------------------------------lecture_return_serie()------------------------------- + #def lecture_return_serie(): + # global gpsData + # gpsData = None + # while gpsData == None : #Tant que 'gpsData' est non définie alors on capture les information provenant du port serie et on retourne le resultat. + # + # ser = serial.Serial('/dev/ttyACM0',4800,timeout=0) #Open Serial port Configure le Recepteur G.P.S + # + # data = ser.readline() #Lecture de la liason serie Ligne par Ligne + # + # if "$GPRMC" in data: #SELECTION DE LA LIGNE GPRMC + # gpsData = parse_GPRMC(data) #ENREGISTREMENT DES DONNEES GPS DANS LA VARIABLE Globale 'gpsData' + # + # return gpsData + #-------------------------------lecture_return_serie()------------------------------- diff --git a/Services/Exemple_Services/Infos_Hardware.py b/Services/Exemple_Services/Infos_Hardware.py new file mode 100644 index 0000000..9543237 --- /dev/null +++ b/Services/Exemple_Services/Infos_Hardware.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +#PYTHON 3.x EDITION +#AIDES: https://pythonconverter.com/ + +#AIDES: https://stackoverflow.com/questions/9229333/how-to-get-overall-cpu-sage-e-g-57-on-linux +#AIDES: https://stackoverflow.com/questions/10585978/linux-command-for-percentage-of-memory-that-is-free +#AIDES: https://docs.python.org/2/library/commands.html + + +import os +import sys +import datetime +import time +from nettoyage_du_cache import clear_cache + + +import io +import subprocess + + +def CPU_usage(): + #Charge CPU + global UtilisationCPU + + LectureCommande0=subprocess.getoutput("top -bn 1 | awk 'NR>7{s+=$9} END {print s/4}'") #On execute cette commande pour Obtenir le resultat depuis le sysytem sans passer par un programme tièrce + UtilisationCPU = "Utilisation du Processeur: " + LectureCommande0 + " %" #Enregistrement de la Variable reçu et Mise en forme + print(UtilisationCPU) #Affichage des nouvelles données reçu dans la console + + return UtilisationCPU #Retourne les valeurs pour une prochaine utilisation. + +def CPU_temp(): + #Temperature du CPU/SoC + global tk_cputemp + #f = open("/sys/class/thermal/thermal_zone0/temp") + #t = f.readline () + #cputemp = "CPU temp: "+t + cputemp = subprocess.getoutput("vcgencmd measure_temp") #Obtention de la temperature du Processeur RPI + print(("Temperature du Processeur: "+ cputemp)) #Affichage de la temperature du Processeur RPI obtenue + + #-- + tk_cputemp = "Temperature du Processeur: " + cputemp #Mise en forme pour l'affichage sous Tkinter + #-- + + return tk_cputemp #Retourne la valeur Mise en forme pour Tkinter + +def SoC_info(): + global mesure_voltage + global memoire_processeur + global memoire_gpu + + #Voltage utilisé par le Socket CPU/GPU + LectureCommande1=subprocess.getoutput("vcgencmd measure_volts core") #Obtention de la Tension utilise par le Socket CPU/GPU + mesure_voltage = "Tension utilisé par l'ensemble CPU/GPU: " + LectureCommande1 #Enregistrement des Informations dans une Variable + print(mesure_voltage) #Affichage des informations dans la console + + #Indication de la Mémoire Vive alouée pour le Processeur + LectureCommande2=subprocess.getoutput("vcgencmd get_mem arm") #Obtention de la memoire vive alouee pour le CPU + memoire_processeur = "Mémoire Vive alouée pour le Processeur: " + LectureCommande2 #Enregistrement de cette information dans une variable + print(memoire_processeur) #Affichage de l'information dans la console + + #Indication de la Mémoire Vive alouée pour le Processeur Graphique + LectureCommande3=subprocess.getoutput("vcgencmd get_mem gpu") #Obtention de la memoire vive alouee pour le GPU + memoire_gpu = "Mémoire Vive alouée pour le Processeur Graphique: " + LectureCommande3 #Enregistrement de l'information dans une variable + print(memoire_gpu) #Affichage de cette information dans la console + + return mesure_voltage,memoire_processeur,memoire_gpu #Toutes les Informations sont retournees pour Traitement par Tkinter + +def MEM_info(): + #Charge Memoire Vive + global MemoireUtilise + LectureCommande4=subprocess.getoutput("free | grep Mem | awk '{print $3/$2 * 100.0}'") #Obtention de la memoire utilise par le Systeme + MemoireUtilise = "Memoire Vive Utilise: " + LectureCommande4 + " %" #Enregistrement de cette information + print(MemoireUtilise) #Affichage de cette information + + return MemoireUtilise #Cette information est retournee a Tkinter + + +if __name__ == "__main__": + clear_cache() #Nettoyage du Cache Python. + CPU_usage() #Obtention du Niveau d'utilisation du Processeur. + CPU_temp() #Obtention de la Temperature du Processeur. + SoC_info() #Obtention d'information par rapport au Couple CPU/GPU. + MEM_info() #Obtention d'information par rapport à la Memoire Vive. diff --git a/Services/Exemple_Services/Recuperation_FR_GPS.py b/Services/Exemple_Services/Recuperation_FR_GPS.py new file mode 100644 index 0000000..725ecfa --- /dev/null +++ b/Services/Exemple_Services/Recuperation_FR_GPS.py @@ -0,0 +1,51 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- + +#Aides : +#https://gist.github.com/Lauszus/5785023 +#https://raspberry-pi.developpez.com/cours-tutoriels/projets-rpi-zero/traceur-gps/ + +import serial +import time +import os +import sys + +import unicodedata #Cette blibliothèque permet de travailler avec du contenue contenant des accents + +ser = serial.Serial('/dev/ttyACM0',4800,timeout=1) # Open Serial port Configure le Recepteur G.P.S + +#Recuparation des informations de la Trame GPRMC contenant les coordonnees GPS principales + +# Helper function to take a $GPRMC sentence, and turn it into a Python dictionary. +def parse_GPRMC(data): + data = data.split(',') + dict = { + 'Temps_Capture': data[1], + 'Validite': data[2], + 'Latitude': data[3], + 'Latitude_Hemisphere' : data[4], + 'Longitude' : data[5], + 'Longitude_Hemisphere' : data[6], + 'Vitesse': data[7], + #'Angle': data[8], + #'fix_date': data[9], + #'variation': data[10], + #'variation_e_w' : data[11], + 'Checksum' : data[12] + } + + return dict + +def envoie(): + + print (gpsData) #Affiche les données GPS + return gpsData #Retourne les données GPS pour une utilisation ultérieur + +while True: + + line = ser.readline() #Lecture de la liason serie Ligne par Ligne + + if "$GPRMC" in line: #SELECTION DE LA LIGNE GPRMC + gpsData = parse_GPRMC(line) #ENREGISTREMENT DES DONNEES GPS DANS LA VARIABLE Globale 'gpsData' + + envoie(); #Utilisation de la fonction envoie() diff --git a/Services/Exemple_Services/nettoyage_du_cache.py b/Services/Exemple_Services/nettoyage_du_cache.py new file mode 100644 index 0000000..4654cc9 --- /dev/null +++ b/Services/Exemple_Services/nettoyage_du_cache.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- + +#PYTHON 3.x EDITION +#AIDES: https://pythonconverter.com/ +#Aides : https://blog.mozilla.org/webdev/2015/10/27/eradicating-those-nasty-pyc-files/ + +import serial +import time +import os +import sys + +#Supprime les fichiers CACHE du language PYTHON +def clear_cache(): + print("Les Fichiers CACHES python perimées ont ete supprimer!") + #print("\n") + #print("Execution de la commande") + os.system("sudo find . -name '*.pyc' -delete") + #"Obviously, this can be used for any file type that you wish to eradicate, not just .pyc files." + +if __name__ == '__main__': + clear_cache() #Fonctionnalité qui permet de supprimer les fichiers CACHE produit par l'utilisation du langage PYTHON diff --git a/Services/Sounds/BF3_FIGHT.mp3 b/Services/Sounds/BF3_FIGHT.mp3 new file mode 100644 index 0000000..3328855 Binary files /dev/null and b/Services/Sounds/BF3_FIGHT.mp3 differ diff --git a/Services/Sounds/BF3_TR.mp3 b/Services/Sounds/BF3_TR.mp3 new file mode 100644 index 0000000..3640bdf Binary files /dev/null and b/Services/Sounds/BF3_TR.mp3 differ diff --git a/Services/Sounds/MSN-MAIL.mp3 b/Services/Sounds/MSN-MAIL.mp3 new file mode 100644 index 0000000..2b71c5f Binary files /dev/null and b/Services/Sounds/MSN-MAIL.mp3 differ diff --git a/Services/Sounds/MSN_ENLIGNE.mp3 b/Services/Sounds/MSN_ENLIGNE.mp3 new file mode 100644 index 0000000..2ba47e1 Binary files /dev/null and b/Services/Sounds/MSN_ENLIGNE.mp3 differ diff --git a/Services/Sounds/MSN_ENTRANT.mp3 b/Services/Sounds/MSN_ENTRANT.mp3 new file mode 100644 index 0000000..d91c303 Binary files /dev/null and b/Services/Sounds/MSN_ENTRANT.mp3 differ diff --git a/Services/Sounds/MSN_Nouveau_MSG.mp3 b/Services/Sounds/MSN_Nouveau_MSG.mp3 new file mode 100644 index 0000000..9c9c3a8 Binary files /dev/null and b/Services/Sounds/MSN_Nouveau_MSG.mp3 differ diff --git a/Services/Sounds/MSN_SORTANT.mp3 b/Services/Sounds/MSN_SORTANT.mp3 new file mode 100644 index 0000000..d76da23 Binary files /dev/null and b/Services/Sounds/MSN_SORTANT.mp3 differ diff --git a/Services/Sounds/MSN_WIZZ.mp3 b/Services/Sounds/MSN_WIZZ.mp3 new file mode 100644 index 0000000..20b17fe Binary files /dev/null and b/Services/Sounds/MSN_WIZZ.mp3 differ diff --git a/Services/Sounds/Monika_happy_story_telling.mp3 b/Services/Sounds/Monika_happy_story_telling.mp3 new file mode 100644 index 0000000..b32502e Binary files /dev/null and b/Services/Sounds/Monika_happy_story_telling.mp3 differ diff --git a/Services/Sounds/Monika_light-switch-sound-effect.mp3 b/Services/Sounds/Monika_light-switch-sound-effect.mp3 new file mode 100644 index 0000000..a29df63 Binary files /dev/null and b/Services/Sounds/Monika_light-switch-sound-effect.mp3 differ diff --git a/Services/Sounds/Monika_notif.mp3 b/Services/Sounds/Monika_notif.mp3 new file mode 100644 index 0000000..84a12f9 Binary files /dev/null and b/Services/Sounds/Monika_notif.mp3 differ diff --git a/Services/Sounds/Monika_rain_2.mp3 b/Services/Sounds/Monika_rain_2.mp3 new file mode 100644 index 0000000..d5be007 Binary files /dev/null and b/Services/Sounds/Monika_rain_2.mp3 differ diff --git a/Services/Sounds/Monika_thunder.mp3 b/Services/Sounds/Monika_thunder.mp3 new file mode 100644 index 0000000..0dc91a6 Binary files /dev/null and b/Services/Sounds/Monika_thunder.mp3 differ diff --git a/Services/Sounds/Monika_thunder_1.mp3 b/Services/Sounds/Monika_thunder_1.mp3 new file mode 100644 index 0000000..6a98704 Binary files /dev/null and b/Services/Sounds/Monika_thunder_1.mp3 differ diff --git a/Services/Sounds/Win7_Startup.mp3 b/Services/Sounds/Win7_Startup.mp3 new file mode 100644 index 0000000..5a7f93e Binary files /dev/null and b/Services/Sounds/Win7_Startup.mp3 differ diff --git a/Services/Sounds/Win7_shutdown.mp3 b/Services/Sounds/Win7_shutdown.mp3 new file mode 100644 index 0000000..ac50a0d Binary files /dev/null and b/Services/Sounds/Win7_shutdown.mp3 differ diff --git a/Services/Sounds/WinXP_Startup.mp3 b/Services/Sounds/WinXP_Startup.mp3 new file mode 100644 index 0000000..3920072 Binary files /dev/null and b/Services/Sounds/WinXP_Startup.mp3 differ diff --git a/Services/Sounds/WinXP_shutdown.mp3 b/Services/Sounds/WinXP_shutdown.mp3 new file mode 100644 index 0000000..1ba2ce4 Binary files /dev/null and b/Services/Sounds/WinXP_shutdown.mp3 differ diff --git a/Services/Sounds/Windows_Error.mp3 b/Services/Sounds/Windows_Error.mp3 new file mode 100644 index 0000000..4f52d94 Binary files /dev/null and b/Services/Sounds/Windows_Error.mp3 differ diff --git a/Services/Sounds/Windows_Exclamation.mp3 b/Services/Sounds/Windows_Exclamation.mp3 new file mode 100644 index 0000000..dbd075d Binary files /dev/null and b/Services/Sounds/Windows_Exclamation.mp3 differ diff --git a/Services/Sounds/Windows_Hardware_Fail.mp3 b/Services/Sounds/Windows_Hardware_Fail.mp3 new file mode 100644 index 0000000..1f31e54 Binary files /dev/null and b/Services/Sounds/Windows_Hardware_Fail.mp3 differ diff --git a/Services/Sounds/Windows_Hardware_Insert.mp3 b/Services/Sounds/Windows_Hardware_Insert.mp3 new file mode 100644 index 0000000..d46c2ec Binary files /dev/null and b/Services/Sounds/Windows_Hardware_Insert.mp3 differ diff --git a/Services/Sounds/Windows_Hardware_Remove.mp3 b/Services/Sounds/Windows_Hardware_Remove.mp3 new file mode 100644 index 0000000..2145f35 Binary files /dev/null and b/Services/Sounds/Windows_Hardware_Remove.mp3 differ diff --git a/Services/Sounds/Windows_Logoff_Sound.mp3 b/Services/Sounds/Windows_Logoff_Sound.mp3 new file mode 100644 index 0000000..a43720d Binary files /dev/null and b/Services/Sounds/Windows_Logoff_Sound.mp3 differ diff --git a/Services/Sounds/Windows_Logon_Sound.mp3 b/Services/Sounds/Windows_Logon_Sound.mp3 new file mode 100644 index 0000000..2f52930 Binary files /dev/null and b/Services/Sounds/Windows_Logon_Sound.mp3 differ diff --git a/Services/Sounds/Windows_Navigation_Start.mp3 b/Services/Sounds/Windows_Navigation_Start.mp3 new file mode 100644 index 0000000..4eca53b Binary files /dev/null and b/Services/Sounds/Windows_Navigation_Start.mp3 differ diff --git a/Services/Sounds/Windows_Notify.mp3 b/Services/Sounds/Windows_Notify.mp3 new file mode 100644 index 0000000..ea476bf Binary files /dev/null and b/Services/Sounds/Windows_Notify.mp3 differ diff --git a/Services/Sounds/Windows_Shutdown.mp3 b/Services/Sounds/Windows_Shutdown.mp3 new file mode 100644 index 0000000..4c85257 Binary files /dev/null and b/Services/Sounds/Windows_Shutdown.mp3 differ diff --git a/Services/Videos/BF3_loop.avi b/Services/Videos/BF3_loop.avi new file mode 100644 index 0000000..7d6b341 Binary files /dev/null and b/Services/Videos/BF3_loop.avi differ diff --git a/Services/Videos/BF3_loop.mp4 b/Services/Videos/BF3_loop.mp4 new file mode 100644 index 0000000..f9a09c9 Binary files /dev/null and b/Services/Videos/BF3_loop.mp4 differ diff --git a/Services/Videos/BF4_loop1.mp4 b/Services/Videos/BF4_loop1.mp4 new file mode 100644 index 0000000..4112c2d Binary files /dev/null and b/Services/Videos/BF4_loop1.mp4 differ diff --git a/Services/Videos/BF4_loop2.mp4 b/Services/Videos/BF4_loop2.mp4 new file mode 100644 index 0000000..194ab2e Binary files /dev/null and b/Services/Videos/BF4_loop2.mp4 differ diff --git "a/Services/Videos/Bravo_vous_\303\252tes_sur_Internet_-_Version_Courte.mp4" "b/Services/Videos/Bravo_vous_\303\252tes_sur_Internet_-_Version_Courte.mp4" new file mode 100644 index 0000000..032e778 Binary files /dev/null and "b/Services/Videos/Bravo_vous_\303\252tes_sur_Internet_-_Version_Courte.mp4" differ diff --git a/Services/__pycache__/Infos_Hardware.cpython-35.pyc b/Services/__pycache__/Infos_Hardware.cpython-35.pyc new file mode 100644 index 0000000..11f074d Binary files /dev/null and b/Services/__pycache__/Infos_Hardware.cpython-35.pyc differ diff --git a/Services/__pycache__/nettoyage_du_cache.cpython-35.pyc b/Services/__pycache__/nettoyage_du_cache.cpython-35.pyc new file mode 100644 index 0000000..26e374b Binary files /dev/null and b/Services/__pycache__/nettoyage_du_cache.cpython-35.pyc differ diff --git a/Template_UI/RASPBIAN/Kivy/Interface_Kivy.kv b/Template_UI/RASPBIAN/Kivy/Interface_Kivy.kv new file mode 100644 index 0000000..4d3b700 --- /dev/null +++ b/Template_UI/RASPBIAN/Kivy/Interface_Kivy.kv @@ -0,0 +1,155 @@ +#Pour gérer la partie KV soit on ecrit le contenue directement dans cette methode de cette facon ou alors on renseigne de cette meme facon un fichier local avec ce contenue +#Lorque le language KV est utiliser, il est pas necessaire d'importer quoi que ce soit. +#--------------------------------------------------------------------------------------------------------------------------------------- + + + BoxLayout: + orientation: 'vertical' + + Label: #WIDGET Permettant l'affichage d'un mot/phrase/variable + id: Label_Horloge #Identifiant permettant a ce label d'etre accessible via le code python + text_language: "fr" #Ligne permettant de connaitre la langue utiliser dans ce label + text: root.Time_Horloge #Valeur qui doit etre afficher a l'ecran + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (13,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Label: + id: Label_UtilisationCPU + text_language: "fr" + text: root.UtilisationCPU + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (73,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Label: + id: Label_MemoireUtilise + text_language: "fr" + text: root.MemoireUtilise + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (73,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Label: + id: Label_CPUtemp + text_language: "fr" + text: root.CPUtemp + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (73,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Label: + id: Label_Info_Supp + text_language: "fr" + text: "Aucune Informations Supp. à affichée pour le moment." + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (73,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Button: #Ce bouton va nous permettre de changer d'ecran Kivy + text:"Fonctionnalitee 1" #On indique un texte sur le bouton + on_press: root.manager.current = 'Fonctionnalitee 1' #On indique la fonction du bouton, dans ce cas le changement d'ecran via le ScreenManager de Kivy + + Button: + text: "Fonctionnalitee 2" + on_press: root.manager.current = 'Fonctionnalitee 2' + + Button: + text: "Fonctionnalitee 3" + on_press: root.manager.current = 'Fonctionnalitee 3' +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- + + BoxLayout: + orientation: 'vertical' + + Label: #WIDGET Permettant l'affichage d'un mot/phrase + id: Label_Chocolat #Identifiant permettant a ce label d'etre accessible via le code python + text_language: "fr" #Ligne permettant de connaitre la langue utiliser dans ce label + text: "Chocolat" #Valeur qui doit etre afficher a l'ecran + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (13,1,1,1) #Parametre permettant d'ajouter de la couleur a un label + + Label: + id: Label_Noisette + text_language: "fr" + text: "Noisette" + + Label: + id: Label_Lait + text_language: "fr" + text: "Lait" + + Label: + id: Label_Vitamine + text_language: "fr" + text: "Vitamine" + + Button: + text:"Accueil" + on_press: root.manager.current = 'Accueil' +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- + + + BoxLayout: + orientation: 'vertical' + + Label: #WIDGET Permettant l'affichage d'un mot/phrase + id: Label_FONC2 #Identifiant permettant a ce label d'etre accessible via le code python + text_language: "fr" #Ligne permettant de connaitre la langue utiliser dans ce label + text: "Deuxième Fonctionnalitee" #Valeur qui doit etre afficher a l'ecran + + bold: False #Parametre permettant de mettre en gras un label + italic: False #Permet de mettre en italique le contenue du label + underline : True #Permet de souligner le contenue du label + color: (13,1,13,1) #Parametre permettant d'ajouter de la couleur a un label + + TextInput: + id: Entree_texte #Identifiant permettant a ce label d'etre accessible via le code python + text:"Mon Message" #Texte visible dans l'entree texte lors de son affichage + allow_copy: True #Autorise le copier/coller + auto_indent: True #Kivy peut automatiquement indenter le contenue de l'entree + cursor_blink: True #Le curseur quand il sera place dans l'entree; il clignotera pour annoncer sa presence + keyboard_suggestions : True #Les clavier intelligent pourront presenter a l'utilisateur des mots a suggerer a entree + + Button: + text:"Accueil" + on_press: root.manager.current = 'Accueil' + +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- + + + BoxLayout: + orientation: 'vertical' + + Label: #WIDGET Permettant l'affichage d'un mot/phrase + id: Label_FONC3 #Identifiant permettant a ce label d'etre accessible via le code python + text_language: "fr" #Ligne permettant de connaitre la langue utiliser dans ce label + text: "Troisième Fonctionnalitee" #Valeur qui doit etre afficher a l'ecran + + bold: False #Parametre permettant de mettre en gras un label + italic: True #Permet de mettre en italique le contenue du label + underline : False #Permet de souligner le contenue du label + color: (13,1,1,73) #Parametre permettant d'ajouter de la couleur a un labe + + Button: + text:"Accueil" + on_press: root.manager.current = 'Accueil' +#--------------------------------------------------------------------------------------------------------------------------------------- diff --git a/Template_UI/RASPBIAN/Kivy/Interface_Kivy.py b/Template_UI/RASPBIAN/Kivy/Interface_Kivy.py new file mode 100644 index 0000000..79dab8d --- /dev/null +++ b/Template_UI/RASPBIAN/Kivy/Interface_Kivy.py @@ -0,0 +1,170 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +#ROCHAT_FRANCK +#Aides: https://kivy.org/doc/stable/guide/lang.html #Documenation sur la Synthax a avoir +#Aides: https://kivy.org/doc/stable/api-kivy.uix.label.html #Documentation sur les differents Widgets de base de Kivy +#Aides: https://kivy.org/doc/stable/api-kivy.uix.boxlayout.html #Documentation sur le Layout (couche) dit 'BoxLayout' de Kivy +#Aides: https://kivy.org/doc/stable/api-kivy.uix.screenmanager.html #Documentation sur les ScreenManagers et leurs fonctionnalités + +#---------------------------------------Importante LIB--------------------------------------- +import os #Blibliotheque permettant l'interaction avec le systeme +import sys #Blibliotheque permettant l'interaction avec le systeme +import datetime #Blibliotheque permettant d'obtenir la date +import time #Blibliotheque permettant d'obtenir la date +#---------------------------------------Importante LIB--------------------------------------- + +#---------------------------------------Project LIB--------------------------------------- +import getpass #On importe la blibliotheque "getpass" +global USERNAME +USERNAME = getpass.getuser() #On enregistre le Nom de l'Utilisateur + +#from pydub import AudioSegment #Bibliotheque permettant de jouer des Sons et Jingles +#from pydub.playback import play #Bibliotheque permettant de jouer des Sons et Jingles + +print("\n Bonjour/Bonsoir, ne pas faire fonctionner ce programme en utilisant les droits/commandes administrateur si l'utilisateur n'est pas l'Admin au quel cas le programme ne fonctionnera pas correctement. \n") #Information a lire dans la console +sys.path.append("/home/"+USERNAME+"/FR_Template/Services") #On indique au systeme ou ce situe le repertoire "Services" dans l'Appareil +#print(USERNAME) #Test debug + +from Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour +from Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere +from Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU +from Infos_Hardware import MEM_info #Obtention de l'utilisation de la Memoire Vive du Systeme +#---------------------------------------Project LIB--------------------------------------- + + +#---------------------------------------Kivy LIB--------------------------------------- +from kivy.app import App #Utile a Kivy +from kivy.uix.boxlayout import BoxLayout #Importation de la disposition BoxLayout +from kivy.uix.anchorlayout import AnchorLayout #Importation de la disposition AnchorLayout + +from kivy.uix.widget import Widget #Importation des différents widget disponible +from kivy.properties import StringProperty #Importation du StringProperty permettant de faire des variables dynamiques +from kivy.clock import Clock #Importation de Clock permettant de gerer les mises a jour des elements +from kivy.lang import Builder #Importation de Builder pour la lecture et l'interpretation du language KV +from kivy.uix.screenmanager import ScreenManager, Screen #Importation de ScreenManager/Screen permettant la gestion de plusieurs 'ecran'(aka Fenetre ou page). +from kivy.uix.popup import Popup #Importation des Popup de Kivy +from kivy.uix.label import Label #Importation des Label de Kivy +from kivy.uix.button import Button #Importation des Boutton de Kivy + +#---------------------------------------Kivy LIB--------------------------------------- +#--------------------------------------------------------------------------------------------------------------------------------------- +#Builder.load_string(""" """) #Saisie indiquant la disposition des elements visuels +Builder.load_file('Interface_Kivy.kv') #Chargement du fichier qui indique la disposition des elements visuels +#--------------------------------------------------------------------------------------------------------------------------------------- +class MaDisposition(BoxLayout, Screen): + #---Variables a Mettre a jour--- + + #--Horloge-- + Time_Horloge = StringProperty() #Quand cette variable changera, toute les elements comportant cette variable se mettront a jour lorsque sa valeurs changera car elle est specifie 'StringProperty' + #--Horloge-- + + #--Informations Materiels-- + UtilisationCPU = StringProperty() #Quand cette variable changera, toute les elements comportant cette variable se mettront a jour lorsque sa valeurs changera car elle est specifie 'StringProperty' + MemoireUtilise = StringProperty() #Quand cette variable changera, toute les elements comportant cette variable se mettront a jour lorsque sa valeurs changera car elle est specifie 'StringProperty' + CPUtemp = StringProperty() #Quand cette variable changera, toute les elements comportant cette variable se mettront a jour lorsque sa valeurs changera car elle est specifie 'StringProperty' + #--Informations Materiels-- + + #--Informations Complementaires-- + #--Informations Complementaires-- + + #---Variables a Mettre a jour--- + def __init__(self, **kwargs): + super(MaDisposition, self).__init__(**kwargs) #On SuperCharge la classe + + #---Elements a Mettre a jour--- + #Exemple: + #Clock.schedule_once(self.methode) + #Clock.schedule_interval(self.methode, X Secondes d'interval de rafraichissement) + Clock.schedule_interval(self.temps_actuel_update,1) + Clock.schedule_interval(self.update_information_Materiel,1) #On indique a Kivy quand Commencer/Re-commencer l'execution d'une methode + #Clock.schedule_once(self.update_information_Complementaire) + #Clock.schedule_interval(self.update_information_Complementaire, 313) + #---Elements a Mettre a jour--- + + + #--------------------------------------------- + def temps_actuel(self): + #OBTENTION DE L'HEURE ACTUEL sous format HEURE,MINUTE,SECONDE + #-- DEBUT -- Heure,Minute,Seconde + tt = time.time() + system_time = datetime.datetime.fromtimestamp(tt).strftime('%H:%M:%S') + print(("Voici l'heure:",system_time)) + return system_time + #-- FIN -- Heure,Minute,Seconde + def temps_actuel_update(self, *args): #On met a jour l'Objet Time_Horloge avec l'heure de la methode precedente + self.Time_Horloge = MaDisposition.temps_actuel(self) + #--------------------------------------------- + + #--------------------------------------------- + def information_Materiel(self): + #Obtention des Informations Materiel de l'Ordinateur + + #-- + self.UtilisationCPU = CPU_usage() #Obtention du Niveau d'utilisation du Processeur. + self.MemoireUtilise = MEM_info() #Obtention d'information par rapport à la Memoire Vive. + self.CPUtemp = CPU_temp() #Obtention de la Temperature du Package Processeur/GPU. + #mesure_voltage,memoire_processeur,memoire_gpu = SoC_info() #Obtention d'information par rapport au Couple CPU/GPU. + #-- + + def update_information_Materiel(self, *args): + #Mise a Jour des Informations a Propos du Materiel + #-- + self.UtilisationCPU = CPU_usage() #Obtention du Niveau d'utilisation du Processeur. + self.MemoireUtilise = MEM_info() #Obtention d'information par rapport à la Memoire Vive. + self.CPUtemp = CPU_temp() #Obtention de la Temperature du Package Processeur/GPU. + #-- + #--------------------------------------------- + + #--------------------------------------------- + def information_Complementaire(self): + #Recuperation des Informations + print("Aucune Informations Supp. à affichée pour le moment.") #On Obtient un mot dans le carnet de correspondance. + + #def update_information_Complementaire(self, *args): + # #Mise à Jour des Informations reçues + # print("Carnet Mise a Jour") #On met a jour le carnet de correspondance. + #--------------------------------------------- +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- +class Fonctionnalitee_1(BoxLayout, Screen): + print("Fonctionnalitee_1") +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- +class Fonctionnalitee_2(BoxLayout, Screen): + print("Fonctionnalitee_2") +#--------------------------------------------------------------------------------------------------------------------------------------- + +#--------------------------------------------------------------------------------------------------------------------------------------- +class Fonctionnalitee_3(BoxLayout, Screen): + print("Fonctionnalitee_3") +#--------------------------------------------------------------------------------------------------------------------------------------- + +#---------------------------------------------Creation du Screen Manager--------------------------------------------- +#HELP: https://kivy.org/doc/stable/api-kivy.uix.screenmanager.html +#Dans cette partie du code, on indique les differents 'ecrans' ou fenetres que dispose ce logiciel sous Kivy +sm = ScreenManager() +sm.add_widget(MaDisposition(name ='Accueil')) +sm.add_widget(Fonctionnalitee_1(name='Fonctionnalitee 1')) +sm.add_widget(Fonctionnalitee_2(name='Fonctionnalitee 2')) +sm.add_widget(Fonctionnalitee_3(name='Fonctionnalitee 3')) +#---------------------------------------------Creation du Screen Manager--------------------------------------------- + +class CryptoWatchApp(App): + + def on_start(self): + #Indique ce que l'on fait au demarage du logiciel. + pass + + def on_stop(self): + #Indique ce que l'on fait a l'arret du logiciel. + pass + + def build(self): + #Demarage du Logiciel Kivy. + return sm + +if __name__ == "__main__": + #Demarage du Logiciel Kivy + CryptoWatchApp().run() diff --git a/Template_UI/RASPBIAN/Kivy/__init__.py b/Template_UI/RASPBIAN/Kivy/__init__.py new file mode 100644 index 0000000..8cb7f45 --- /dev/null +++ b/Template_UI/RASPBIAN/Kivy/__init__.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- diff --git a/Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py b/Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py new file mode 100644 index 0000000..0792ac8 --- /dev/null +++ b/Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py @@ -0,0 +1,195 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +#ROCHAT_FRANCK +#---------------------------------------Importante LIB--------------------------------------- +import os #Blibliotheque permettant l'interaction avec le systeme +import sys #Blibliotheque permettant l'interaction avec le systeme +import datetime #Blibliotheque permettant d'obtenir la date +import time #Blibliotheque permettant d'obtenir la date + +import getpass #On importe la blibliotheque "getpass" +global USERNAME +USERNAME = getpass.getuser() #On enregistre le Nom de l'Utilisateur + +from tkinter import * #Blibliotheque permettant d'obtenir Tkinter(G.U.I) +from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I) +import tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I) + +#from pydub import AudioSegment #Bibliotheque permettant de jouer des Sons et Jingles +#from pydub.playback import play #Bibliotheque permettant de jouer des Sons et Jingles +#---------------------------------------Importante LIB--------------------------------------- + +#-----------------------------------------------------Localisation de l'emplacement des fichiers necessaires----------------------------------------------------- +print("\n Bonjour/Bonsoir, ne pas faire fonctionner ce programme en utilisant les droits/commandes administrateur si l'utilisateur n'est pas l'Admin au quel cas le programme ne fonctionnera pas correctement. \n") #Information a lire dans la console +sys.path.append("/home/"+USERNAME+"/FR_Template/Services") #On indique au systeme ou ce situe le repertoire "Services" dans l'Appareil +#print(USERNAME) #Test debug + +#from nettoyage_du_cache import clear_cache #Bibliotheque permettant de nettoyer les fichiers cache PYTHON + +from Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour +from Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere +from Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU +from Infos_Hardware import MEM_info #Obtention de l'utilisation de la Memoire Vive du Systeme +#-----------------------------------------------------Localisation de l'emplacement des fichiers necessaires----------------------------------------------------- + +#-------------Fenetre Maitre------------- +fenetre = Tk() #Creation d'une Fenetre Maîtresse TK appeler "fenetre" +#-------------Fenetre Maitre------------- + +#-------------------------------------------------------------------Contenue Fenetre Principale------------------------------------------------------------------- +#------------------------------------------------------------------------------ #Affichage du Temps HEURES/MINUTES/SECONDES +def temps_actuel(): + #OBTENTION DE L'HEURE ACTUEL sous format HEURE,MINUTE,SECONDE + #-- DEBUT -- Heure,Minute,Seconde + tt = time.time() + system_time = datetime.datetime.fromtimestamp(tt).strftime('%H:%M:%S') + print(("Voici l'heure:",system_time)) + return system_time + #-- FIN -- Heure,Minute,Seconde + +#--------------------------------------------- +status_temps_actuel = Label(fenetre, text=temps_actuel()) #Affichage du Temps (Label) +status_temps_actuel.pack() #Pour obtenir un affichage dynamique , Il faut utiliser pack/grid de cette façon +#--------------------------------------------- + +def update_temps_actuel(): #Fonctionnalité permettant de mettre à jour l'Heure en fonction du Temps Réel + # On met à jour le temps actuel dans le champs text du Widget LABEL pour afficher l'heure + status_temps_actuel["text"] = temps_actuel() + # Après une seconde , on met à jour le contenue text du LABEL + fenetre.after(1000, update_temps_actuel) +#------------------------------------------------------------------------------ + +#------------------------------------------------------------------------------ +def information_Materiel(): + #Obtention des Informations Materiel de l'Ordinateur + global tk_UtilisationCPU + global tk_tk_cputemp + global tk_MemoireUtilise + + #-- + UtilisationCPU = CPU_usage() #Obtention du Niveau d'utilisation du Processeur. + MemoireUtilise = MEM_info() #Obtention d'information par rapport à la Memoire Vive. + tk_cputemp = CPU_temp() #Obtention de la Temperature du Package Processeur/GPU. + mesure_voltage,memoire_processeur,memoire_gpu = SoC_info() #Obtention d'information par rapport au Couple CPU/GPU. + #-- + + #--Affichage-- + EnveloppeInfoMateriel = LabelFrame(fenetre, text="Informations Relatives aux Matériels", padx=5, pady=5) #Création d'une "Zone Frame" à Label + EnveloppeInfoMateriel.pack(fill="both", expand="no") #Position de la "Zone Frame" à Label dans la fenêtre + tk_UtilisationCPU = Label(EnveloppeInfoMateriel, text=UtilisationCPU) + tk_MemoireUtilise = Label(EnveloppeInfoMateriel, text=MemoireUtilise) + tk_tk_cputemp = Label(EnveloppeInfoMateriel, text=tk_cputemp) + tk_UtilisationCPU.pack() + tk_MemoireUtilise.pack() + tk_tk_cputemp.pack() + #--Affichage-- + +def update_information_Materiel(): + #Mise a Jour des Informations a Propos du Materiel + tk_UtilisationCPU["text"] = CPU_usage() + tk_MemoireUtilise["text"] = MEM_info() + tk_tk_cputemp["text"] = CPU_temp() + # Après une seconde , on met à jour le contenue text du LABEL + fenetre.after(1000, update_information_Materiel) +#--- +information_Materiel() #Lancement de la Fonctionnalitée. +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def information_Complementaire(): + global tk_info_supp + #Recuperation des Informations + INFOS_SUPP = "Aucune Informations Supp. à affichée pour le moment." + + #--Affichage-- + EnveloppeInfoComplementaire = LabelFrame(fenetre, text="Informations Complémentaires", padx=5, pady=5) #Création d'une "Zone Frame" à Label + EnveloppeInfoComplementaire.pack(fill="both", expand="no") + + #---Affichage Infos--- + tk_info_supp = Label(EnveloppeInfoComplementaire, text= INFOS_SUPP) + tk_info_supp.pack() + #---Affichage Infos--- + #--Affichage-- + +def update_information_Complementaire(): + #Mise à Jour des Informations reçues + tk_info_supp["text"] = INFOS_SUPP + + # Après 2,16 minutes , on met à jour le contenue text du LABEL + fenetre.after(130000, update_information_Complementaire) +#--- +information_Complementaire() #Lancement de la Fonctionnalitée. +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def Fonctionnalitee_1(): + print("Fonctionnalitée 1") + + #Etape-1 On Declare la fenetre + global Fonct_1 + Fonct_1 = Toplevel() + + #Etape-2 On recupere les informations a afficher + Informations = "Voici la fonctionnalite Numero #1" + + #Etape-3 On fait la mise en page des Informations receptionner + #Zone d'affichage + EnveloppeFonction1 = LabelFrame(Fonct_1, text="Emplacement dédié a l'information", padx=5, pady=5) #Création d'une "Zone Frame" à Label + EnveloppeFonction1.pack(fill="both", expand="no") #Position de la "Zone Frame" à Label dans la fenêtre + + Chocolat = Label(EnveloppeFonction1, text="Chocolat") + Noisette = Label(EnveloppeFonction1, text="Noisette") + Lait = Label(EnveloppeFonction1, text="Lait") + Vitamine = Label(EnveloppeFonction1, text="Vitamine") + + #Etape-4 Indication de l'Emplacement des Informations dans l'Interface + Chocolat.pack() + Noisette.pack() + Lait.pack() + Vitamine.pack() + + #Etape-5 Bouton(s) + Button(Fonct_1, text="Fermer", command=Fonct_1.destroy).pack() #Bouton de Fermeture de la Fenetre actuelle +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def Fonctionnalitee_2(): + print("Fonctionnalitée 2") +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def Fonctionnalitee_3(): + print("Fonctionnalitée 3") +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +Button(fenetre, text="Fonctionnalitée 1", command=Fonctionnalitee_1).pack() #Bouton +Button(fenetre, text="Fonctionnalitée 2", command=Fonctionnalitee_2).pack() #Bouton +Button(fenetre, text="Fonctionnalitée 3", command=Fonctionnalitee_3).pack() #Bouton +Button(fenetre, text="Fermer", command=fenetre.destroy).pack() #Bouton de Fermeture de la Fenetre Principale +#-------------------------------------------------------------------Contenue Fenetres Secondaires------------------------------------------------------------------- + +if __name__ == "__main__": + try: + #clear_cache() + #-------------------------------------------------------------------Demarrage des fonctions operant sur la Fenetre Principale------------------------------------------------------------------- + #Récupération des informations pour la Mise à jour du LABEL toute les 1 milliseconde quand la fenêtre Maitre est lancée + fenetre.after(1, update_temps_actuel) #update_temps_actuel() + fenetre.after(1, update_information_Materiel) #update_information_Materiel() + #fenetre.after(1, update_information_Complementaire) #update_information_Complementaire() + fenetre.mainloop() #Boucle de Lancement de la Fenêtre PRINCIPAL + #-------------------------------------------------------------------Demarrage des fonctions operant sur la Fenetre Principale--------------------------------------------------------------- + pass + + #---!!!GESTION DES ERREURS!!!--- + #Utiliser uniquement quand le produit est finaliser et/ou commenter les lignes durant le devellopement pour determiner les bugs. + #except TypeError: + # print("Code Erreur: TypeError") + #except KeyError: + # print("Code Erreur: KeyError") + #except ValueError: + # print("Code Erreur: ValueError") + #except AssertionError: + # print("Code Erreur: AssertionError") + #except NameError: + # print("Il est necessaire de Redemarrez le Programme!") #On affiche ce message dans la console + # print("Code Erreur: NameError") + except: + print("Il est necessaire de Redemarrez le Logiciel!") #On affiche ce message dans la console + print("Code Erreur: Aucun") + #---!!!GESTION DES ERREURS!!!--- diff --git a/Template_UI/RASPBIAN/Tkinter/__init__.py b/Template_UI/RASPBIAN/Tkinter/__init__.py new file mode 100644 index 0000000..8cb7f45 --- /dev/null +++ b/Template_UI/RASPBIAN/Tkinter/__init__.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- diff --git a/Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py b/Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py new file mode 100644 index 0000000..ffe8987 --- /dev/null +++ b/Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py @@ -0,0 +1,178 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +#ROCHAT_FRANCK +#---------------------------------------Importante LIB--------------------------------------- +import datetime #Bibliotheque permettant d'obtenir la date +import time #Bibliotheque permettant d'obtenir la date +from tkinter import * #Bibliotheque permettant d'obtenir Tkinter(G.U.I) +from tkinter import Tk, Label #Bibliotheque permettant d'obtenir Tkinter(G.U.I +import psutil #Bibliotheque permettant d'obtenir des infos systèmes +#---------------------------------------Importante LIB--------------------------------------- +#-----------------------------------------------------Localisation de l'emplacement des fichiers nécessaires----------------------------------------------------- +print( + "\n Bonjour/Bonsoir, ne pas faire fonctionner ce programme en utilisant les droits/commandes administrateur si l'utilisateur n'est pas l'Admin au quel cas le programme ne fonctionnera pas correctement. \n") #Information à lire dans la console +#... +#-----------------------------------------------------Localisation de l'emplacement des fichiers nécessaires----------------------------------------------------- +#-------------Fenetre Maitre------------- +fenetre: Tk = Tk() #Creation d'une fenêtre Maîtresse TK appelé "fenêtre" +fenetre.title('Projet GABRIEL') +#-------------Fenetre Maitre------------- +#-------------------------------------------------------------------Contenue Fenetre Principale------------------------------------------------------------------- +#------------------------------------------------------------------------------ #Affichage du Temps HEURES/MINUTES/SECONDES +def temps_actuel(): + #OBTENTION DE L'HEURE ACTUEL sous format HEURE,MINUTE,SECONDE + #-- DEBUT -- Heure,Minute,Seconde + tt = time.time() + system_time = datetime.datetime.fromtimestamp(tt).strftime('%H:%M:%S') + print(("Voici l'heure:", system_time)) + return system_time + #-- FIN -- Heure,Minute,Seconde +#--------------------------------------------- + +status_temps_actuel = Label(fenetre, text=temps_actuel()) #Affichage du Temps (Label) +status_temps_actuel.pack() #Pour obtenir un affichage dynamique, il faut utiliser pack/grid de cette façon + +#--------------------------------------------- +def update_temps_actuel(): #Fonctionnalité permettant de mettre à jour l'Heure en fonction du Temps Réel + # On met à jour le temps actuel dans le champ text du Widget LABEL pour afficher l'heure + status_temps_actuel["text"] = temps_actuel() + # Après une seconde, on met à jour le contenu text du LABEL + fenetre.after(1000, update_temps_actuel) +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +# noinspection PyGlobalUndefined +def information_Materiel(): + #Obtention des Informations Materiel de l'Ordinateur + global tk_UtilisationCPU + global tk_tk_diskUsage + global tk_MemoireUtilise + #-- + UtilisationCPU = "0%" #Obtention du Niveau d'utilisation du Processeur. + MemoireUtilise = "0%" #Obtention d'information par rapport à la Memoire Vive. + tk_diskUsage = "0%" #Obtention de la Temperature du Package Processeur/GPU. + #-- + #--Affichage-- + EnveloppeInfoMateriel = LabelFrame(fenetre, text="Informations Relatives aux Matériels", padx=5, + pady=5) #Création d'une "Zone Frame" à Label + EnveloppeInfoMateriel.pack(fill="both", expand=0) #Position de la "Zone Frame" à Label dans la fenêtre + tk_UtilisationCPU = Label(EnveloppeInfoMateriel, text=UtilisationCPU) + tk_MemoireUtilise = Label(EnveloppeInfoMateriel, text=MemoireUtilise) + tk_tk_diskUsage = Label(EnveloppeInfoMateriel, text=tk_diskUsage) + tk_UtilisationCPU.pack() + tk_MemoireUtilise.pack() + tk_tk_diskUsage.pack() + #--Affichage-- +def update_information_Materiel(): + UtilisationCPU = psutil.cpu_percent(interval=None) + MemoireUtilise = psutil.virtual_memory()[2] + diskUsage = psutil.disk_usage('/').percent + + #Mise à Jour des Informations à propos du Materiel + tk_UtilisationCPU["text"] = "Utilisation du Processeur: " + str(UtilisationCPU) + " %" + tk_MemoireUtilise["text"] = "Memoire Vive Utilise: " + str(MemoireUtilise) + " %" + tk_tk_diskUsage["text"] = "Utilisation du disque: " + str(diskUsage) + " %" + + #Après une seconde, on met à jour le contenu text du LABEL + fenetre.after(1000, update_information_Materiel) +#--- +information_Materiel() #Lancement de la Fonctionnalitée. +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def information_Complementaire(): + #Recuperation des Informations + INFOS_SUPP = "Aucune Informations Supp. à afficher pour le moment." + + #--Affichage-- + EnveloppeInfoComplementaire = LabelFrame(fenetre, text="Informations Complémentaires", padx=5, + pady=5) #Création d'une "Zone Frame" à Label + EnveloppeInfoComplementaire.pack(fill="both", expand=0) + #---Affichage Infos--- + tk_info_supp = Label(EnveloppeInfoComplementaire, text=INFOS_SUPP) + tk_info_supp.pack() + + #---Affichage Infos--- + #--Affichage-- + def update_information_Complementaire(): + #Mise à Jour des Informations reçues + tk_info_supp["text"] = INFOS_SUPP + #Après 2,16 minutes, on met à jour le contenu text du LABEL + fenetre.after(13000, update_information_Complementaire) + #--- +information_Complementaire() #Lancement de la Fonctionnalitée. +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +# noinspection PyTypeChecker +def Fonctionnalitee_1(): + print("Fonctionnalitée 1") + + #Etape-1 On Declare la fenêtre + #global fonct_1 + fonct_1 = Toplevel() + + #Etape-2 On récupère les informations à afficher + Informations = "Voici la fonctionnalitee numéro #1" + print(Informations) + #Etape-3 On fait la mise en page des Informations réceptionner + #Zone d'affichage + EnveloppeFonction1 = LabelFrame(fonct_1, text="Emplacement dédié a l'information", padx=5, + pady=5) #Création d'une "Zone Frame" à Label + EnveloppeFonction1.pack(fill="both", expand=0) #Position de la "Zone Frame" à Label dans la fenêtre + + Chocolat = Label(EnveloppeFonction1, text="Chocolat") + Noisette = Label(EnveloppeFonction1, text="Noisette") + Lait = Label(EnveloppeFonction1, text="Lait") + Vitamine = Label(EnveloppeFonction1, text="Vitamine") + + #Etape-4 Indication de l'Emplacement des Informations dans l'Interface + Chocolat.pack() + Noisette.pack() + Lait.pack() + Vitamine.pack() + + #Etape-5 Bouton(s) + Button(fonct_1, text="Fermer", command=fonct_1.destroy).pack() #Bouton de Fermeture de la fenêtre actuelle +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def Fonctionnalitee_2(): + print("Fonctionnalitée 2") +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +def Fonctionnalitee_3(): + print("Fonctionnalitée 3") +#------------------------------------------------------------------------------ +#------------------------------------------------------------------------------ +Button(fenetre, text="Fonctionnalitée 1", command=Fonctionnalitee_1).pack() #Bouton +Button(fenetre, text="Fonctionnalitée 2", command=Fonctionnalitee_2).pack() #Bouton +Button(fenetre, text="Fonctionnalitée 3", command=Fonctionnalitee_3).pack() #Bouton +Button(fenetre, text="Fermer", command=fenetre.destroy).pack() #Bouton de Fermeture de la fenêtre Principale +#-------------------------------------------------------------------Contenue fenêtre Secondaires------------------------------------------------------------------- +if __name__ == "__main__": + # noinspection PyBroadException + try: + #clear_cache() + #-------------------------------------------------------------------Démarrage des fonctions operant sur la fenêtre Principale------------------------------------------------------------------- + #Récupération des informations pour la Mise à jour du LABEL toute les 1 milliseconde quand la fenêtre Maitre est lancée + fenetre.after(1, update_temps_actuel) #update_temps_actuel() + fenetre.after(1, update_information_Materiel) #update_information_Materiel() + #fenetre.after(1, update_information_Complementaire) #update_information_Complementaire() + fenetre.mainloop() #Boucle de Lancement de la Fenêtre PRINCIPAL + #-------------------------------------------------------------------Démarrage des fonctions operant sur la fenêtre Principale--------------------------------------------------------------- + pass + + #---!!!GESTION DES ERREURS!!!--- + #Utiliser uniquement quand le produit est finalisé et/ou commenter les lignes durant le development pour determiner les bugs. + #except TypeError: + # print("Code Erreur: TypeError") + #except KeyError: + # print("Code Erreur: KeyError") + #except ValueError: + # print("Code Erreur: ValueError") + #except AssertionError: + # print("Code Erreur: AssertionError") + #except NameError: + # print("Il est nécessaire de redémarrer le programme !") #On affiche ce message dans la console + # print("Code Erreur: NameError") + except: + print("Il est nécessaire de redémarrer le Logiciel!") #On affiche ce message dans la console + print("Code Erreur: Aucun") + #---!!!GESTION DES ERREURS!!!--- \ No newline at end of file diff --git a/Template_UI/WINDOWS/Tkinter/__init__.py b/Template_UI/WINDOWS/Tkinter/__init__.py new file mode 100644 index 0000000..8cb7f45 --- /dev/null +++ b/Template_UI/WINDOWS/Tkinter/__init__.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000..8cb7f45 --- /dev/null +++ b/__init__.py @@ -0,0 +1,2 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..c419263 --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/qodana.sarif.json b/qodana.sarif.json new file mode 100644 index 0000000..16bc6d1 --- /dev/null +++ b/qodana.sarif.json @@ -0,0 +1,8348 @@ +{ + "$schema": "https://raw.githubusercontent.com/schemastore/schemastore/master/src/schemas/json/sarif-2.1.0-rtm.5.json", + "version": "2.1.0", + "runs": [ + { + "tool": { + "driver": { + "name": "PC", + "fullName": "Qodana", + "version": "241.17890.14", + "rules": [], + "taxa": [ + { + "id": "Python", + "name": "Python" + }, + { + "id": "EditorConfig", + "name": "EditorConfig" + }, + { + "id": "Shell script", + "name": "Shell script" + }, + { + "id": "XML", + "name": "XML" + }, + { + "id": "YAML", + "name": "YAML" + }, + { + "id": "JSON and JSON5", + "name": "JSON and JSON5" + }, + { + "id": "RegExp", + "name": "RegExp" + }, + { + "id": "Properties files", + "name": "Properties files" + }, + { + "id": "Markdown", + "name": "Markdown" + }, + { + "id": "HTML", + "name": "HTML" + }, + { + "id": "General", + "name": "General" + }, + { + "id": "ReST", + "name": "ReST" + }, + { + "id": "Requirements", + "name": "Requirements" + }, + { + "id": "Qodana", + "name": "Qodana" + }, + { + "id": "Python/Security", + "name": "Security", + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RELAX NG", + "name": "RELAX NG" + }, + { + "id": "Proofreading", + "name": "Proofreading" + }, + { + "id": "Internationalization", + "name": "Internationalization" + }, + { + "id": "TOML", + "name": "TOML" + }, + { + "id": "Security", + "name": "Security" + }, + { + "id": "Version control", + "name": "Version control" + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + "extensions": [ + { + "name": "PythonCore", + "version": "241.17890.14", + "rules": [ + { + "id": "PyPandasSeriesToListInspection", + "shortDescription": { + "text": "Method Series.to_list() is recommended" + }, + "fullDescription": { + "text": "Reports redundant 'list' in 'list(Series.values)' statement for pandas and polars libraries. Such 'Series' values extraction can be replaced with the 'to_list()' function call. Example: list(df['column'].values)\n When the quick-fix is applied, the code changes to: df['column'].to_list()", + "markdown": "Reports redundant `list` in `list(Series.values)` statement for pandas and polars libraries.\nSuch `Series` values extraction can be replaced with the `to_list()` function call.\n\n**Example:**\n\n```\nlist(df['column'].values)\n```\n\nWhen the quick-fix is applied, the code changes to:\n\n```\ndf['column'].to_list()\n```" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyPackages", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PySetFunctionToLiteralInspection", + "shortDescription": { + "text": "Function call can be replaced with set literal" + }, + "fullDescription": { + "text": "Reports calls to the 'set' function that can be replaced with the 'set' literal. Example: 'def do_mult(a, b):\n c = a * b\n return set([c, a, b])' When the quick-fix is applied, the code changes to: 'def do_mult(a, b):\n c = a * b\n return {c, a, b}'", + "markdown": "Reports calls to the `set` function that can be replaced with\nthe `set` literal.\n\n**Example:**\n\n\n def do_mult(a, b):\n c = a * b\n return set([c, a, b])\n\nWhen the quick-fix is applied, the code changes to:\n\n\n def do_mult(a, b):\n c = a * b\n return {c, a, b}\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PySetFunctionToLiteral", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyStatementEffectInspection", + "shortDescription": { + "text": "Statement has no effect" + }, + "fullDescription": { + "text": "Reports statements that have no effect. Example: 'class Car:\n def __init__(self, speed=0):\n self.speed = speed\n self.time # has no effect\n\n2 + 3 # has no effect' In this example, you can either add a field 'time' to the 'Car' class or introduce variables for the problematic statements.", + "markdown": "Reports statements that have no effect.\n\n**Example:**\n\n\n class Car:\n def __init__(self, speed=0):\n self.speed = speed\n self.time # has no effect\n\n 2 + 3 # has no effect\n\nIn this example, you can either add a field `time` to the `Car` class or\nintroduce variables for the problematic statements." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyStatementEffect", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMandatoryEncodingInspection", + "shortDescription": { + "text": "No encoding specified for file" + }, + "fullDescription": { + "text": "Reports a missing encoding comment in Python 2. Example: 'class Book(object):\n def __init__(self):\n pass' When the quick-fix is applied, the missing comment is added: '# coding=utf-8\nclass Book(object):\n def __init__(self):\n pass'", + "markdown": "Reports a missing encoding comment in Python 2.\n\n**Example:**\n\n\n class Book(object):\n def __init__(self):\n pass\n\nWhen the quick-fix is applied, the missing comment is added:\n\n\n # coding=utf-8\n class Book(object):\n def __init__(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "PyMandatoryEncoding", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyOverridesInspection", + "shortDescription": { + "text": "Invalid usages of @override decorator" + }, + "fullDescription": { + "text": "Reports when a method decorated with @override doesn't have a matching method in its ancestor classes Example: 'from typing import override\n\nclass Parent:\n def foo(self) -> int:\n return 1\n\n def bar(self, x: str) -> str:\n return x\n\nclass Child(Parent):\n @override\n def foo(self) -> int:\n return 2\n\n @override # Missing super method for override function\n def baz(self) -> int:\n return 1'", + "markdown": "Reports when a method decorated with @override doesn't have a matching method in its ancestor classes\n\n**Example:**\n\n\n from typing import override\n\n class Parent:\n def foo(self) -> int:\n return 1\n\n def bar(self, x: str) -> str:\n return x\n\n class Child(Parent):\n @override\n def foo(self) -> int:\n return 2\n\n @override # Missing super method for override function\n def baz(self) -> int:\n return 1\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyOverrides", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyInconsistentIndentationInspection", + "shortDescription": { + "text": "Inconsistent indentation" + }, + "fullDescription": { + "text": "Reports inconsistent indentation in Python source files when, for example, you use a mixture of tabs and spaces in your code.", + "markdown": "Reports inconsistent indentation in Python source files when, for example,\nyou use a mixture of tabs and spaces in your code." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyInconsistentIndentation", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyAttributeOutsideInitInspection", + "shortDescription": { + "text": "An instance attribute is defined outside `__init__`" + }, + "fullDescription": { + "text": "Reports a problem when instance attribute definition is outside '__init__' method. Example: 'class Book:\n def __init__(self):\n self.author = 'Mark Twain'\n\n def release(self):\n self.year = '1889'' When the quick-fix is applied, the code sample changes to: 'class Book:\n def __init__(self):\n self.year = '1889'\n self.author = 'Mark Twain'\n\n def release(self):\n pass'", + "markdown": "Reports a problem when instance attribute definition is outside `__init__` method.\n\n**Example:**\n\n\n class Book:\n def __init__(self):\n self.author = 'Mark Twain'\n\n def release(self):\n self.year = '1889'\n\n\nWhen the quick-fix is applied, the code sample changes to:\n\n\n class Book:\n def __init__(self):\n self.year = '1889'\n self.author = 'Mark Twain'\n\n def release(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyAttributeOutsideInit", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTypedDictInspection", + "shortDescription": { + "text": "Invalid TypedDict definition and usages" + }, + "fullDescription": { + "text": "Reports invalid definition and usage of TypedDict. Example: 'from typing import TypedDict\n\n\nclass Movie(TypedDict):\n name: str\n year: int\n rate: int = 10 # Right-hand side values are not supported\n\n def method(self): # Invalid statement in TypedDict\n pass\n\n\nm = Movie(name=\"name\", year=1000, rate=9)\nprint(m[\"director\"]) # There is no the 'director' key in 'Movie'\ndel m[\"name\"] # The 'name' key cannot be deleted\nm[\"year\"] = \"1001\" # Expected 'int', got 'str''", + "markdown": "Reports invalid definition and usage of\n[TypedDict](https://www.python.org/dev/peps/pep-0589/).\n\n**Example:**\n\n\n from typing import TypedDict\n\n\n class Movie(TypedDict):\n name: str\n year: int\n rate: int = 10 # Right-hand side values are not supported\n\n def method(self): # Invalid statement in TypedDict\n pass\n\n\n m = Movie(name=\"name\", year=1000, rate=9)\n print(m[\"director\"]) # There is no the 'director' key in 'Movie'\n del m[\"name\"] # The 'name' key cannot be deleted\n m[\"year\"] = \"1001\" # Expected 'int', got 'str'\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTypedDict", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyPep8Inspection", + "shortDescription": { + "text": "PEP 8 coding style violation" + }, + "fullDescription": { + "text": "Reports violations of the PEP 8 coding style guide by running the bundled pycodestyle.py tool.", + "markdown": "Reports violations of the [PEP 8 coding style guide](https://www.python.org/dev/peps/pep-0008/) by running the bundled [pycodestyle.py](https://github.com/PyCQA/pycodestyle) tool." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyPep8", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMissingTypeHintsInspection", + "shortDescription": { + "text": "Missing type hinting for function definition" + }, + "fullDescription": { + "text": "Reports missing type hints for function declaration in one of the two formats: parameter annotations or a type comment. Select the Only when types are known checkbox if you want the inspection check the types collected from runtime or inferred.", + "markdown": "Reports missing type hints for function declaration in\none of the two formats: parameter annotations or a type comment.\n\nSelect the **Only when types are known** checkbox if you want the inspection check\nthe types collected from runtime or inferred." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "PyMissingTypeHints", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTupleItemAssignmentInspection", + "shortDescription": { + "text": "Tuple item assignment is prohibited" + }, + "fullDescription": { + "text": "Reports assignments to a tuple item. Example: 't = ('red', 'blue', 'green', 'white')\nt[3] = 'black'' A quick-fix offers to replace the tuple with a list.", + "markdown": "Reports assignments to a tuple item.\n\n**Example:**\n\n\n t = ('red', 'blue', 'green', 'white')\n t[3] = 'black'\n\nA quick-fix offers to replace the tuple with a list." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTupleItemAssignment", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyInitNewSignatureInspection", + "shortDescription": { + "text": "Incompatible signatures of __new__ and __init__" + }, + "fullDescription": { + "text": "Reports incompatible signatures of the '__new__' and '__init__' methods. Example: 'class MyClass(object):\n def __new__(cls, arg1):\n return super().__new__(cls)\n\n def __init__(self):\n pass' If the '__new__' and '__init__' have different arguments, then the 'MyClass' cannot be instantiated. As a fix, the IDE offers to apply the Change Signature refactoring.", + "markdown": "Reports incompatible signatures of the `__new__` and `__init__` methods.\n\n**Example:**\n\n\n class MyClass(object):\n def __new__(cls, arg1):\n return super().__new__(cls)\n\n def __init__(self):\n pass\n\nIf the `__new__` and `__init__` have different arguments, then the `MyClass`\ncannot be instantiated.\n\nAs a fix, the IDE offers to apply the Change Signature refactoring." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyInitNewSignature", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDunderSlotsInspection", + "shortDescription": { + "text": "Invalid usages of classes with '__slots__' definitions" + }, + "fullDescription": { + "text": "Reports invalid usages of a class with '__slots__' definitions. Example: 'class Foo:\n __slots__ = ['foo', 'bar']\n\n\nfoo = Foo()\nfoo.baz = 'spam''", + "markdown": "Reports invalid usages of a class with `__slots__` definitions.\n\n**Example:**\n\n\n class Foo:\n __slots__ = ['foo', 'bar']\n\n\n foo = Foo()\n foo.baz = 'spam'\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDunderSlots", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMissingConstructorInspection", + "shortDescription": { + "text": "Missed call to '__init__' of the super class" + }, + "fullDescription": { + "text": "Reports cases when a call to the 'super' constructor in a class is missed. Example: 'class Fruit:\n def __init__(self):\n pass\n\n\nclass Pear(Fruit):\n def __init__(self):\n pass' The 'Pear' class should have a 'super' call in the '__init__' method. When the quick-fix is applied, the code changes to: 'class Fruit:\n def __init__(self):\n pass\n\n\nclass Pear(Fruit):\n def __init__(self):\n super().__init__()'", + "markdown": "Reports cases when a call to the `super` constructor in a class is missed.\n\n**Example:**\n\n\n class Fruit:\n def __init__(self):\n pass\n\n\n class Pear(Fruit):\n def __init__(self):\n pass\n\nThe `Pear` class should have a `super` call in the `__init__`\nmethod.\n\nWhen the quick-fix is applied, the code changes to:\n\n\n class Fruit:\n def __init__(self):\n pass\n\n\n class Pear(Fruit):\n def __init__(self):\n super().__init__()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyMissingConstructor", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDefaultArgumentInspection", + "shortDescription": { + "text": "The default argument is mutable" + }, + "fullDescription": { + "text": "Reports a problem when a mutable value as a list or dictionary is detected in a default value for an argument. Default argument values are evaluated only once at function definition time, which means that modifying the default value of the argument will affect all subsequent calls of that function. Example: 'def func(s, cache={}):\n cache[s] = None' When the quick-fix is applied, the code changes to: 'def func(s, cache=None):\n if cache is None:\n cache = {}\n cache[s] = None'", + "markdown": "Reports a problem when a mutable value as a list or dictionary is detected in a default value for\nan argument. \n\nDefault argument values are evaluated only once at function definition time,\nwhich means that modifying the\ndefault value of the argument will affect all subsequent calls of that function.\n\n**Example:**\n\n\n def func(s, cache={}):\n cache[s] = None\n\nWhen the quick-fix is applied, the code changes to:\n\n\n def func(s, cache=None):\n if cache is None:\n cache = {}\n cache[s] = None\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDefaultArgument", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTestUnpassedFixtureInspection", + "shortDescription": { + "text": "Fixture is not requested by test functions" + }, + "fullDescription": { + "text": "Reports if a fixture is used without being passed to test function parameters or to '@pytest.mark.usefixtures' decorator", + "markdown": "Reports if a fixture is used without being passed to test function parameters or to `@pytest.mark.usefixtures` decorator" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTestUnpassedFixture", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyShadowingBuiltinsInspection", + "shortDescription": { + "text": "Shadowing built-in names" + }, + "fullDescription": { + "text": "Reports shadowing built-in names, such as 'len' or 'list'. Example: 'def len(a, b, c):\n d = a + b + c\n return d' In this code fragment, the 'len' built-in name is used. The IDE offers to apply the Rename refactoring as a fix.", + "markdown": "Reports shadowing built-in names, such as `len` or `list`.\n\n**Example:**\n\n\n def len(a, b, c):\n d = a + b + c\n return d\n\nIn this code fragment, the `len` built-in name is used. The IDE offers to\napply the Rename refactoring as a fix." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyShadowingBuiltins", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PySimplifyBooleanCheckInspection", + "shortDescription": { + "text": "Redundant boolean variable check" + }, + "fullDescription": { + "text": "Reports equality comparison with a boolean literal. Example: 'def func(s):\n if s.isdigit() == True:\n return int(s)' With the quick-fix applied, the code fragment will be simplified to: 'def func(s):\n if s.isdigit():\n return int(s)'", + "markdown": "Reports equality comparison with a boolean literal.\n\n**Example:**\n\n\n def func(s):\n if s.isdigit() == True:\n return int(s)\n\nWith the quick-fix applied, the code fragment will be simplified to:\n\n\n def func(s):\n if s.isdigit():\n return int(s)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PySimplifyBooleanCheck", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMethodOverridingInspection", + "shortDescription": { + "text": "Method signature does not match signature of overridden method" + }, + "fullDescription": { + "text": "Reports inconsistencies in overriding method signatures. Example: 'class Book:\n def add_title(self):\n pass\n\n\nclass Novel(Book):\n def add_title(self, text):\n pass' Parameters of the 'add_title' method in the 'Novel' class do not match the method signature specified in the 'Book' class. As a fix, the IDE offers to apply the Change Signature refactoring.", + "markdown": "Reports inconsistencies in overriding method signatures.\n\n**Example:**\n\n\n class Book:\n def add_title(self):\n pass\n\n\n class Novel(Book):\n def add_title(self, text):\n pass\n\nParameters of the `add_title` method in the `Novel` class do not match the method\nsignature specified in the `Book` class. As a fix, the IDE offers to apply the Change Signature\nrefactoring." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyMethodOverriding", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PoetryPackageVersionsInspection", + "shortDescription": { + "text": "Poetry package versions" + }, + "fullDescription": { + "text": "Reports outdated versions of packages in '[tool.poetry.dependencies]' and '[tool.poetry.dev-dependencies]' sections of 'pyproject.toml'.", + "markdown": "Reports outdated versions of packages in `[tool.poetry.dependencies]` and `[tool.poetry.dev-dependencies]`\nsections of `pyproject.toml`." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PoetryPackageVersions", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTestParametrizedInspection", + "shortDescription": { + "text": "Incorrect arguments in @pytest.mark.parametrize" + }, + "fullDescription": { + "text": "Reports functions that are decorated with @pytest.mark.parametrize but do not have arguments to accept parameters of the decorator.", + "markdown": "Reports functions that are decorated with [@pytest.mark.parametrize](https://docs.pytest.org/en/stable/parametrize.html) but do not have arguments to accept\nparameters of the decorator." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTestParametrized", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDecoratorInspection", + "shortDescription": { + "text": "Class-specific decorator is used outside the class" + }, + "fullDescription": { + "text": "Reports usages of '@classmethod' or '@staticmethod' decorators in methods outside a class. Example: 'class State(object):\n\n @classmethod\n def my_state(cls, name):\n cls.name = name\n\n\n@classmethod\ndef change_state(self):\n pass' The 'change_state' method should not use the '@classmethod' decorator or it should be moved to the 'State' class declaration. If you apply the 'Remove decorator' action, the code changes to: 'class State(object):\n\n @classmethod\n def my_state(cls, name):\n cls.name = name\n\n\ndef change_state(self):\n pass'", + "markdown": "Reports usages of `@classmethod` or `@staticmethod` decorators\nin methods outside a class.\n\n**Example:**\n\n\n class State(object):\n\n @classmethod\n def my_state(cls, name):\n cls.name = name\n\n\n @classmethod\n def change_state(self):\n pass\n\nThe `change_state` method should not use the `@classmethod` decorator or it should be\nmoved to the `State` class declaration.\n\nIf you apply the `Remove decorator` action, the code changes to:\n\n\n class State(object):\n\n @classmethod\n def my_state(cls, name):\n cls.name = name\n\n\n def change_state(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDecorator", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyAsyncCallInspection", + "shortDescription": { + "text": "Missing `await` syntax in coroutine calls" + }, + "fullDescription": { + "text": "Reports coroutines that were called without using the 'await' syntax. Example: 'async def bar():\n pass\n\n\nasync def foo():\n bar()' After the quick-fix is applied, the code changes to: 'async def bar():\n pass\n\n\nasync def foo():\n await bar()'", + "markdown": "Reports coroutines that were called\nwithout using the `await` syntax.\n\n**Example:**\n\n\n async def bar():\n pass\n\n\n async def foo():\n bar()\n\nAfter the quick-fix is applied, the code changes to:\n\n\n async def bar():\n pass\n\n\n async def foo():\n await bar()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyAsyncCall", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RestRoleInspection", + "shortDescription": { + "text": "Role is not defined" + }, + "fullDescription": { + "text": "Reports undefined roles in reStructuredText files. Example: '.. role:: custom\n.. role:: newcustom(emphasis)\n\nAn example of using :custom:`interpreted text`\nAn example of using :newcustom:`interpreted text`\nAn example of using :emphasis:`interpreted text`\n\n\nSome text using undefined role :undef:`interpreted text`'", + "markdown": "Reports undefined roles in reStructuredText files.\n\n**Example:**\n\n\n .. role:: custom\n .. role:: newcustom(emphasis)\n\n An example of using :custom:`interpreted text`\n An example of using :newcustom:`interpreted text`\n An example of using :emphasis:`interpreted text`\n\n\n Some text using undefined role :undef:`interpreted text`\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "RestRoleInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "ReST", + "index": 11, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CommandLineInspection", + "shortDescription": { + "text": "Incorrect CLI syntax" + }, + "fullDescription": { + "text": "Reports the problems if the arguments of the command you type in the console are not in the proper order. The inspection also verifies that option names and arguments are correct. Do not disable the inspection if you are going to use command-line interfaces like manage.py in Django.", + "markdown": "Reports the problems if the arguments of the command you type in the console are not in the proper order. The inspection also verifies\nthat option names and arguments are correct.\n\nDo not disable the inspection if you are going to use command-line interfaces like [manage.py in Django](https://www.jetbrains.com/help/pycharm/running-manage-py.html)." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "CommandLineInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyComparisonWithNoneInspection", + "shortDescription": { + "text": "Using equality operators to compare with None" + }, + "fullDescription": { + "text": "Reports comparisons with 'None'. That type of comparisons should always be done with 'is' or 'is not', never the equality operators. Example: 'a = 2\n\n\nif a == None:\n print(\"Success\")' Once the quick-fix is applied, the code changes to: 'a = 2\n\n\nif a is None:\n print(\"Success\")'", + "markdown": "Reports comparisons with `None`. That type of comparisons\nshould always be done with `is` or `is not`, never\nthe equality operators.\n\n**Example:**\n\n\n a = 2\n\n\n if a == None:\n print(\"Success\")\n\nOnce the quick-fix is applied, the code changes to:\n\n\n a = 2\n\n\n if a is None:\n print(\"Success\")\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyComparisonWithNone", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyCallingNonCallableInspection", + "shortDescription": { + "text": "Attempt to call a non-callable object" + }, + "fullDescription": { + "text": "Reports a problem when you are trying to call objects that are not callable, like, for example, properties: Example: 'class Record:\n @property\n def as_json(self):\n\njson = Record().as_json()'", + "markdown": "Reports a problem when you are trying\nto call objects that are not callable, like, for example, properties:\n\n**Example:**\n\n\n class Record:\n @property\n def as_json(self):\n\n json = Record().as_json()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyCallingNonCallable", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyUnreachableCodeInspection", + "shortDescription": { + "text": "Unreachable code" + }, + "fullDescription": { + "text": "Reports code fragments that cannot be normally reached. Example: 'if True:\n print('Yes')\nelse:\n print('No')' As a fix, you might want to check and modify the algorithm to ensure it implements the expected logic.", + "markdown": "Reports code fragments that cannot be normally reached.\n\n**Example:**\n\n\n if True:\n print('Yes')\n else:\n print('No')\n\nAs a fix, you might want to check and modify the algorithm to ensure it implements\nthe expected logic." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyUnreachableCode", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyChainedComparisonsInspection", + "shortDescription": { + "text": "Too complex chained comparisons" + }, + "fullDescription": { + "text": "Reports chained comparisons that can be simplified. Example: 'def do_comparison(x):\n xmin = 10\n xmax = 100\n if x >= xmin and x <= xmax:\n pass' The IDE offers to simplify 'if x >= xmin and x <= xmax'. When the quick-fix is applied, the code changes to: 'def do_comparison(x):\n xmin = 10\n xmax = 100\n if xmin <= x <= xmax:\n pass'", + "markdown": "Reports chained comparisons that can be simplified.\n\n**Example:**\n\n\n def do_comparison(x):\n xmin = 10\n xmax = 100\n if x >= xmin and x <= xmax:\n pass\n\nThe IDE offers to simplify `if x >= xmin and x <= xmax`.\nWhen the quick-fix is applied, the code changes to:\n\n\n def do_comparison(x):\n xmin = 10\n xmax = 100\n if xmin <= x <= xmax:\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyChainedComparisons", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMethodParametersInspection", + "shortDescription": { + "text": "Improper first parameter" + }, + "fullDescription": { + "text": "Reports methods that lack the first parameter that is usually named 'self'. Example: 'class Movie:\n\n def show():\n pass' When the quick-fix is applied, the code changes to: 'class Movie:\n\n def show(self):\n pass' The inspection also reports naming issues in class methods. Example: 'class Movie:\n @classmethod\n def show(abc):\n pass' Since the first parameter of a class method should be 'cls', the IDE provides a quick-fix to rename it.", + "markdown": "Reports methods that lack the first parameter that is usually\nnamed `self`.\n\n**Example:**\n\n\n class Movie:\n\n def show():\n pass\n\nWhen the quick-fix is applied, the code changes to:\n\n\n class Movie:\n\n def show(self):\n pass\n\nThe inspection also reports naming issues in class methods.\n\n**Example:**\n\n\n class Movie:\n @classmethod\n def show(abc):\n pass\n\nSince the first parameter of a class method should be `cls`, the IDE provides a quick-fix\nto rename it." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyMethodParameters", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDocstringTypesInspection", + "shortDescription": { + "text": "Type in docstring does not match inferred type" + }, + "fullDescription": { + "text": "Reports types in docstring that do not match dynamically inferred types.", + "markdown": "Reports types in docstring that do not match dynamically inferred types." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyDocstringTypes", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyCompatibilityInspection", + "shortDescription": { + "text": "Code is incompatible with specific Python versions" + }, + "fullDescription": { + "text": "Reports incompatibility with the specified versions of Python. Enable this inspection if you need your code to be compatible with a range of Python versions, for example, if you are building a library. To define the range of the inspected Python versions, select the corresponding checkboxes in the Options section. For more information about the Python versions supported by the IDE, see the web help.", + "markdown": "Reports incompatibility with the specified versions of Python.\nEnable this inspection if you need your code to be compatible with a range of Python versions, for example,\nif you are building a library.\n\nTo define the range of the inspected Python versions, select the corresponding checkboxes in the **Options**\nsection.\n\nFor more information about the Python versions supported by the IDE, see the\n[web help](https://www.jetbrains.com/help/pycharm/python.html#support)." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "PyCompatibility", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyGlobalUndefinedInspection", + "shortDescription": { + "text": "Global variable is not defined at the module level" + }, + "fullDescription": { + "text": "Reports problems when a variable defined through the 'global' statement is not defined in the module scope. Example: 'def foo():\n global bar\n print(bar)\n\nfoo()' As a fix, you can move the global variable declaration: 'global bar\n\n\ndef foo():\n print(bar)'", + "markdown": "Reports problems when a variable defined through the `global`\nstatement is not defined in the module scope.\n\n**Example:**\n\n\n def foo():\n global bar\n print(bar)\n\n foo()\n\nAs a fix, you can move the global variable declaration:\n\n\n global bar\n\n\n def foo():\n print(bar)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyGlobalUndefined", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "UnsatisfiedRequirementInspection", + "shortDescription": { + "text": "Requirement is not satisfied" + }, + "fullDescription": { + "text": "Reports packages mentioned in requirements files (for example, 'requirements.txt', or 'dependencies' section in 'pyproject.toml' files) but not installed, or imported but not mentioned in requirements files.", + "markdown": "Reports packages mentioned in requirements files (for example, `requirements.txt`, or `dependencies` section in `pyproject.toml` files) but not installed,\nor imported but not mentioned in requirements files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "UnsatisfiedRequirement", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Requirements", + "index": 12, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMethodFirstArgAssignmentInspection", + "shortDescription": { + "text": "First argument of the method is reassigned" + }, + "fullDescription": { + "text": "Reports cases when the first parameter, such as 'self' or 'cls', is reassigned in a method. Because in most cases, there are no objectives in such reassignment, the IDE indicates an error. Example: 'class Account:\n def calc(self, balance):\n if balance == 0:\n self = balance\n return self' As a fix, you might want to check and modify the algorithm to ensure that reassignment is needed. If everything is correct, you can invoke intention actions for this code and opt to ignore the warning.", + "markdown": "Reports cases when the first parameter,\nsuch as `self` or `cls`, is reassigned in a method.\nBecause in most cases, there are no objectives in such reassignment, the\nIDE indicates an error.\n\n**Example:**\n\n\n class Account:\n def calc(self, balance):\n if balance == 0:\n self = balance\n return self\n\nAs a fix, you might want to check and modify the algorithm to ensure that reassignment is needed. If everything is correct,\nyou can invoke intention actions for this code and opt to ignore the warning." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyMethodFirstArgAssignment", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyNewStyleGenericSyntaxInspection", + "shortDescription": { + "text": "Invalid usage of new-style type parameters and type aliases" + }, + "fullDescription": { + "text": "Reports invalid usage of PEP 695 type parameter syntax Finds the following problems in function and class definitions and new-style type alias statements: Extending typing.Generic in new-style generic classes Extending parameterized typing.Protocol in new-style generic classes Using generic upper bounds and constraints with type parameters for ParamSpec and TypeVarTuple Mixing traditional and new-style type variables Using traditional type variables in new-style type aliases Examples: 'from typing import Generic\n\n class Example[T](Generic[T]): ... # Classes with type parameter list should not extend 'Generic'' 'class Example[T: (list[S], str)]: ... # Generic types are not allowed inside constraints and bounds of type parameters' 'from typing import TypeVar\n\n K = TypeVar(\"K\")\n\n class ClassC[V]:\n def method2[M](self, a: M, b: K) -> M | K: ... # Mixing traditional and new-style TypeVars is not allowed'", + "markdown": "Reports invalid usage of [PEP 695](https://www.python.org/dev/peps/pep-0695/) type parameter syntax\n\n\nFinds the following problems in function and class definitions and new-style type alias statements:\n\n* Extending typing.Generic in new-style generic classes\n* Extending parameterized typing.Protocol in new-style generic classes\n* Using generic upper bounds and constraints with type parameters for ParamSpec and TypeVarTuple\n* Mixing traditional and new-style type variables\n* Using traditional type variables in new-style type aliases\n\n\nExamples:\n\n\n from typing import Generic\n\n class Example[T](Generic[T]): ... # Classes with type parameter list should not extend 'Generic'\n\n\n class Example[T: (list[S], str)]: ... # Generic types are not allowed inside constraints and bounds of type parameters\n\n\n from typing import TypeVar\n\n K = TypeVar(\"K\")\n\n class ClassC[V]:\n def method2[M](self, a: M, b: K) -> M | K: ... # Mixing traditional and new-style TypeVars is not allowed\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyNewStyleGenericSyntax", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyProtocolInspection", + "shortDescription": { + "text": "Invalid protocol definitions and usages" + }, + "fullDescription": { + "text": "Reports invalid definitions and usages of protocols introduced in PEP-544. Example: 'from typing import Protocol\n\n\nclass MyProtocol(Protocol):\n def method(self, p: int) -> str:\n pass\n\n\nclass MyClass(MyProtocol):\n def method(self, p: str) -> int: # Type of 'method' is not compatible with 'MyProtocol'\n pass\n\n\nclass MyAnotherProtocol(MyClass, Protocol): # All bases of a protocol must be protocols\n pass'", + "markdown": "Reports invalid definitions and usages of protocols introduced in\n[PEP-544](https://www.python.org/dev/peps/pep-0544/).\n\n**Example:**\n\n\n from typing import Protocol\n\n\n class MyProtocol(Protocol):\n def method(self, p: int) -> str:\n pass\n\n\n class MyClass(MyProtocol):\n def method(self, p: str) -> int: # Type of 'method' is not compatible with 'MyProtocol'\n pass\n\n\n class MyAnotherProtocol(MyClass, Protocol): # All bases of a protocol must be protocols\n pass\n\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyProtocol", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTypeHintsInspection", + "shortDescription": { + "text": "Invalid type hints definitions and usages" + }, + "fullDescription": { + "text": "Reports invalid usages of type hints. Example: 'from typing import TypeVar\n\nT0 = TypeVar('T1') # Argument of 'TypeVar' must be 'T0'\n\n\ndef b(p: int) -> int: # Type specified both in a comment and annotation\n # type: (int) -> int\n pass\n\n\ndef c(p1, p2): # Type signature has too many arguments\n # type: (int) -> int\n pass' Available quick-fixes offer various actions. You can rename, remove, or move problematic elements. You can also manually modify type declarations to ensure no warning is shown.", + "markdown": "Reports invalid usages of type hints.\n\n**Example:**\n\n\n from typing import TypeVar\n\n T0 = TypeVar('T1') # Argument of 'TypeVar' must be 'T0'\n\n\n def b(p: int) -> int: # Type specified both in a comment and annotation\n # type: (int) -> int\n pass\n\n\n def c(p1, p2): # Type signature has too many arguments\n # type: (int) -> int\n pass\n\nAvailable quick-fixes offer various actions. You can rename, remove, or move problematic elements. You can also manually modify type declarations to ensure no warning is shown." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTypeHints", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMethodMayBeStaticInspection", + "shortDescription": { + "text": "Method is not declared static" + }, + "fullDescription": { + "text": "Reports any methods that do not require a class instance creation and can be made static. Example: 'class MyClass(object):\n def my_method(self, x):\n print(x)' If a Make function from method quick-fix is applied, the code changes to: 'def my_method(x):\n print(x)\n\n\nclass MyClass(object):\n pass' If you select the Make method static quick-fix, the '@staticmethod' decorator is added: 'class MyClass(object):\n @staticmethod\n def my_method(x):\n print(x)'", + "markdown": "Reports any methods that do not require a class instance creation and can be\nmade static.\n\n**Example:**\n\n\n class MyClass(object):\n def my_method(self, x):\n print(x)\n\nIf a **Make function from method** quick-fix is applied, the code changes to:\n\n\n def my_method(x):\n print(x)\n\n\n class MyClass(object):\n pass\n\nIf you select the **Make method static** quick-fix, the `@staticmethod` decorator is added:\n\n\n class MyClass(object):\n @staticmethod\n def my_method(x):\n print(x)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyMethodMayBeStatic", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTupleAssignmentBalanceInspection", + "shortDescription": { + "text": "Tuple assignment balance is incorrect" + }, + "fullDescription": { + "text": "Reports cases when the number of expressions on the right-hand side and targets on the left-hand side are not the same. Example: 't = ('red', 'blue', 'green', 'white')\n(c1, c2, c3) = t' As a quick-fix, you can modify the highlighted code fragment to restore the tuple balance.", + "markdown": "Reports cases when the number of expressions on the right-hand side\nand targets on the left-hand side are not the same.\n\n**Example:**\n\n\n t = ('red', 'blue', 'green', 'white')\n (c1, c2, c3) = t\n\nAs a quick-fix, you can modify the highlighted code fragment to restore the tuple\nbalance." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTupleAssignmentBalance", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyClassHasNoInitInspection", + "shortDescription": { + "text": "Class has no `__init__` method" + }, + "fullDescription": { + "text": "Reports cases in Python 2 when a class has no '__init__' method, neither its parent classes. Example: 'class Book():\n pass' The quick-fix adds the '__init__' method: 'class Book():\n def __init__(self):\n pass'", + "markdown": "Reports cases in Python 2 when a class has no `__init__` method, neither its parent\nclasses.\n\n**Example:**\n\n\n class Book():\n pass\n\nThe quick-fix adds the `__init__` method:\n\n\n class Book():\n def __init__(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyClassHasNoInit", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyArgumentEqualDefaultInspection", + "shortDescription": { + "text": "The function argument is equal to the default parameter value" + }, + "fullDescription": { + "text": "Reports a problem when an argument passed to the function is equal to the default parameter value. This inspection is disabled by default to avoid performance degradation. Example: 'def my_function(a: int = 2):\n print(a)\n\n\nmy_function(2)'", + "markdown": "Reports a problem when an argument\npassed to the function is equal to the default parameter value.\n\nThis inspection is disabled by default to avoid performance degradation.\n\n**Example:**\n\n\n def my_function(a: int = 2):\n print(a)\n\n\n my_function(2)\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "PyArgumentEqualDefault", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyClassVarInspection", + "shortDescription": { + "text": "Invalid usage of ClassVar variables" + }, + "fullDescription": { + "text": "Reports invalid usages of ClassVar annotations. Example: 'from typing import ClassVar\n\n\nclass Cat:\n color: ClassVar[str] = \"white\"\n weight: int\n\n def __init__(self, weight: int):\n self.weight = weight\n\n\nCat.color = \"black\" # OK\nmy_cat = Cat(5)\nmy_cat.color = \"gray\" # Error, setting class variable on instance'", + "markdown": "Reports invalid usages of [ClassVar](https://docs.python.org/3/library/typing.html#typing.ClassVar) annotations.\n\n**Example:**\n\n\n from typing import ClassVar\n\n\n class Cat:\n color: ClassVar[str] = \"white\"\n weight: int\n\n def __init__(self, weight: int):\n self.weight = weight\n\n\n Cat.color = \"black\" # OK\n my_cat = Cat(5)\n my_cat.color = \"gray\" # Error, setting class variable on instance\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyClassVar", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDictCreationInspection", + "shortDescription": { + "text": "Dictionary creation can be rewritten by dictionary literal" + }, + "fullDescription": { + "text": "Reports situations when you can rewrite dictionary creation by using a dictionary literal. This approach brings performance improvements. Example: 'dic = {}\ndic['var'] = 1' When the quick-fix is applied, the code changes to: 'dic = {'var': 1}'", + "markdown": "Reports situations when you can rewrite dictionary creation\nby using a dictionary literal.\n\nThis approach brings performance improvements.\n\n**Example:**\n\n\n dic = {}\n dic['var'] = 1\n\nWhen the quick-fix is applied, the code changes to:\n\n\n dic = {'var': 1}\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyDictCreation", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyStringFormatInspection", + "shortDescription": { + "text": "Errors in string formatting operations" + }, + "fullDescription": { + "text": "Reports errors in string formatting operations. Example 1: '\"Hello {1}\".format(\"people\")' Example 2: 'def bar():\n return 1\n\n\n\"%s %s\" % bar()' As a fix, you need to rewrite string formatting fragments to adhere to the formatting syntax.", + "markdown": "Reports errors in string formatting operations.\n\n**Example 1:**\n\n\n \"Hello {1}\".format(\"people\")\n\n**Example 2:**\n\n\n def bar():\n return 1\n\n\n \"%s %s\" % bar()\n\nAs a fix, you need to rewrite string formatting fragments to\nadhere to the [formatting syntax](https://docs.python.org/3/library/string.html#format-string-syntax)." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyStringFormat", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyExceptionInheritInspection", + "shortDescription": { + "text": "Exceptions do not inherit from standard 'Exception' class" + }, + "fullDescription": { + "text": "Reports cases when a custom exception class is raised but does not inherit from the builtin Exception class. Example: 'class A:\n pass\n\n\ndef me_exception():\n raise A()' The proposed quick-fix changes the code to: 'class A(Exception):\n pass\n\n\ndef me_exception():\n raise A()'", + "markdown": "Reports cases when a custom exception class is\nraised but does not inherit from the\n[builtin Exception class](https://docs.python.org/3/library/exceptions.html).\n\n**Example:**\n\n\n class A:\n pass\n\n\n def me_exception():\n raise A()\n\nThe proposed quick-fix changes the code to:\n\n\n class A(Exception):\n pass\n\n\n def me_exception():\n raise A()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyExceptionInherit", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyAssignmentToLoopOrWithParameterInspection", + "shortDescription": { + "text": "Assignments to 'for' loop or 'with' statement parameter" + }, + "fullDescription": { + "text": "Reports the cases when you rewrite a loop variable with an inner loop. Example: 'for i in range(5):\n for i in range(20, 25):\n print(\"Inner\", i)\n print(\"Outer\", i)' It also warns you if a variable declared in the 'with' statement is redeclared inside the statement body: 'with open(\"file\") as f:\n f.read()\n with open(\"file\") as f:'", + "markdown": "Reports the cases when you rewrite a loop variable with an inner loop.\n\n**Example:**\n\n\n for i in range(5):\n for i in range(20, 25):\n print(\"Inner\", i)\n print(\"Outer\", i)\n \nIt also warns you if a variable declared in the `with` statement is redeclared inside the statement body:\n\n\n with open(\"file\") as f:\n f.read()\n with open(\"file\") as f:\n \n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyAssignmentToLoopOrWithParameter", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyFromFutureImportInspection", + "shortDescription": { + "text": "Improper position of from __future__ import" + }, + "fullDescription": { + "text": "Reports 'from __future__ import' statements that are used not at the beginning of a file. Example: 'a = 1\nfrom __future__ import print_function\nprint()' When the quick-fix is applied, the code changes to: 'from __future__ import print_function\n\na = 1\nprint()'", + "markdown": "Reports `from __future__ import`\nstatements that are used not at\nthe beginning of a file.\n\n**Example:**\n\n\n a = 1\n from __future__ import print_function\n print()\n\nWhen the quick-fix is applied, the code changes to:\n\n\n from __future__ import print_function\n\n a = 1\n print()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyFromFutureImport", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyUnresolvedReferencesInspection", + "shortDescription": { + "text": "Unresolved references" + }, + "fullDescription": { + "text": "Reports references in your code that cannot be resolved. In a dynamically typed language, this is possible in a limited number of cases. If a reference type is unknown, then its attributes are not highlighted as unresolved even if you know that they should be: 'def print_string(s):\n print(s.abc())' In this code fragment 's' is always a string and 'abc' should be highlighted as unresolved. However, 's' type is inferred as 'Any' and no warning is reported. The IDE provides quick-fix actions to add missing references on-the-fly.", + "markdown": "Reports references in your code that cannot be resolved.\n\nIn a dynamically typed language, this is possible in a limited number of cases.\n\nIf a reference type is unknown, then its attributes are not highlighted as unresolved even if you know that they should be:\n\n\n def print_string(s):\n print(s.abc())\n\nIn this code fragment `s` is always a string and `abc` should be highlighted as unresolved. However, `s`\ntype is inferred as `Any` and no warning is reported.\n\nThe IDE provides quick-fix actions to add missing references on-the-fly." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "PyUnresolvedReferences", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PySuperArgumentsInspection", + "shortDescription": { + "text": "Wrong arguments to call super" + }, + "fullDescription": { + "text": "Reports cases when any call to 'super(A, B)' does not meet the following requirements: 'B' is an instance of 'A' 'B' a subclass of 'A' Example: 'class Figure:\n def color(self):\n pass\n\n\nclass Rectangle(Figure):\n def color(self):\n pass\n\n\nclass Square(Figure):\n def color(self):\n return super(Rectangle, self).color() # Square is not an instance or subclass of Rectangle' As a fix, you can make the 'Square' an instance of the 'Rectangle' class.", + "markdown": "Reports cases when any call to `super(A, B)` does not meet the\nfollowing requirements:\n\n* `B` is an instance of `A`\n* `B` a subclass of `A`\n\n**Example:**\n\n\n class Figure:\n def color(self):\n pass\n\n\n class Rectangle(Figure):\n def color(self):\n pass\n\n\n class Square(Figure):\n def color(self):\n return super(Rectangle, self).color() # Square is not an instance or subclass of Rectangle\n\nAs a fix, you can make the `Square` an instance of the `Rectangle` class." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PySuperArguments", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyPackageRequirementsInspection", + "shortDescription": { + "text": "Unsatisfied package requirements" + }, + "fullDescription": { + "text": "Reports packages mentioned in requirements files (for example, 'requirements.txt' or 'Pipfile') but not installed, or imported but not mentioned in requirements files. The IDE shows a quick-fix banner so that you can install the missing packages in one click.", + "markdown": "Reports packages mentioned in requirements files (for example, `requirements.txt` or `Pipfile`) but not installed,\nor imported but not mentioned in requirements files.\n\n\nThe IDE shows a quick-fix banner so that you can install the missing packages in one click." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyPackageRequirements", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyNonAsciiCharInspection", + "shortDescription": { + "text": "File contains non-ASCII character" + }, + "fullDescription": { + "text": "Reports cases in Python 2 when a file contains non-ASCII characters and does not have an encoding declaration at the top. Example: 'class A(object):\n# №5\n def __init__(self):\n pass' In this example, the IDE reports a non-ASCII symbol in a comment and a lack of encoding declaration. Apply the proposed quick-fix to add a missing encoding declaration: '# coding=utf-8\nclass A(object)\n# №5\n def __init__(self):\n pass'", + "markdown": "Reports cases in Python 2 when a file contains non-ASCII characters and does not\nhave an encoding declaration at the top.\n\n**Example:**\n\n\n class A(object):\n # №5\n def __init__(self):\n pass\n\nIn this example, the IDE reports a non-ASCII symbol in a comment and a lack of encoding\ndeclaration. Apply the proposed quick-fix to add a missing encoding declaration:\n\n\n # coding=utf-8\n class A(object)\n # №5\n def __init__(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyNonAsciiChar", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyRedundantParenthesesInspection", + "shortDescription": { + "text": "Redundant parentheses" + }, + "fullDescription": { + "text": "Reports about redundant parentheses in expressions. The IDE provides the quick-fix action to remove the redundant parentheses.", + "markdown": "Reports about redundant parentheses in expressions.\n\nThe IDE provides the quick-fix action to remove the redundant parentheses." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyRedundantParentheses", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTrailingSemicolonInspection", + "shortDescription": { + "text": "Prohibited trailing semicolon in a statement" + }, + "fullDescription": { + "text": "Reports trailing semicolons in statements. Example: 'def my_func(a):\n c = a ** 2;\n return c' IDE provides a quick-fix that removes a trailing semicolon. When you apply it, the code changes to: 'def my_func(a):\n c = a ** 2\n return c'", + "markdown": "Reports trailing semicolons in statements.\n\n**Example:**\n\n\n def my_func(a):\n c = a ** 2;\n return c\n\nIDE provides a quick-fix that removes a trailing semicolon. When you\napply it, the code changes to:\n\n\n def my_func(a):\n c = a ** 2\n return c\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTrailingSemicolon", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyOldStyleClassesInspection", + "shortDescription": { + "text": "Old-style class contains new-style class features" + }, + "fullDescription": { + "text": "Reports occurrences of new-style class features in old-style classes. The inspection highlights '__slots__', '__getattribute__', and 'super()' inside old-style classes.", + "markdown": "Reports occurrences of\n[new-style class features](https://www.python.org/doc/newstyle/)\nin old-style classes. The inspection highlights\n`__slots__`, `__getattribute__`, and `super()`\ninside old-style classes." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyOldStyleClasses", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyAbstractClassInspection", + "shortDescription": { + "text": "Class must implement all abstract methods" + }, + "fullDescription": { + "text": "Reports cases when not all abstract properties or methods are defined in a subclass. Example: 'from abc import abstractmethod, ABC\n\n\nclass Figure(ABC):\n\n @abstractmethod\n def do_figure(self):\n pass\n\n\nclass Triangle(Figure):\n def do_triangle(self):\n pass' When the quick-fix is applied, the IDE implements an abstract method for the 'Triangle' class: 'from abc import abstractmethod, ABC\n\n\nclass Figure(ABC):\n\n @abstractmethod\n def do_figure(self):\n pass\n\n\nclass Triangle(Figure):\n def do_figure(self):\n pass\n\n def do_triangle(self):\n pass'", + "markdown": "Reports cases when not all abstract properties or methods are defined in\na subclass.\n\n**Example:**\n\n\n from abc import abstractmethod, ABC\n\n\n class Figure(ABC):\n\n @abstractmethod\n def do_figure(self):\n pass\n\n\n class Triangle(Figure):\n def do_triangle(self):\n pass\n\nWhen the quick-fix is applied, the IDE implements an abstract method for the `Triangle` class:\n\n\n from abc import abstractmethod, ABC\n\n\n class Figure(ABC):\n\n @abstractmethod\n def do_figure(self):\n pass\n\n\n class Triangle(Figure):\n def do_figure(self):\n pass\n\n def do_triangle(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyAbstractClass", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyArgumentListInspection", + "shortDescription": { + "text": "Incorrect call arguments" + }, + "fullDescription": { + "text": "Reports discrepancies between declared parameters and actual arguments, as well as incorrect arguments, for example, duplicate named arguments, and incorrect argument order. Example: 'class Foo:\n def __call__(self, p1: int, *, p2: str = \"%\"):\n return p2 * p1\n\n\nbar = Foo()\nbar.__call__() # unfilled parameter\nbar(5, \"#\") # unexpected argument' The correct code fragment looks at follows: 'class Foo:\n def __call__(self, p1: int, *, p2: str = \"%\"):\n return p2 * p1\n\n\nbar = Foo()\nbar.__call__(5)\nbar(5, p2=\"#\")'", + "markdown": "Reports discrepancies between declared parameters and actual arguments, as well as\nincorrect arguments, for example, duplicate named arguments, and incorrect argument order.\n\n**Example:**\n\n\n class Foo:\n def __call__(self, p1: int, *, p2: str = \"%\"):\n return p2 * p1\n\n\n bar = Foo()\n bar.__call__() # unfilled parameter\n bar(5, \"#\") # unexpected argument\n\nThe correct code fragment looks at follows:\n\n\n class Foo:\n def __call__(self, p1: int, *, p2: str = \"%\"):\n return p2 * p1\n\n\n bar = Foo()\n bar.__call__(5)\n bar(5, p2=\"#\")\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyArgumentList", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyInterpreterInspection", + "shortDescription": { + "text": "An invalid interpreter" + }, + "fullDescription": { + "text": "Reports problems if there is no Python interpreter configured for the project or if the interpreter is invalid. Without a properly configured interpreter, you cannot execute your Python scripts and benefit from some Python code insight features. The IDE provides quick access to the interpreter settings.", + "markdown": "Reports problems if there is no Python interpreter configured for the project or if the interpreter is invalid. Without a properly\nconfigured interpreter, you cannot execute your Python scripts and benefit from some Python code insight features.\n\nThe IDE provides quick access to the interpreter settings." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "PyInterpreter", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyBroadExceptionInspection", + "shortDescription": { + "text": "Unclear exception clauses" + }, + "fullDescription": { + "text": "Reports exception clauses that do not provide specific information about the problem. Example: Clauses that do not specify an exception class Clauses that are specified as 'Exception'", + "markdown": "Reports exception clauses that do not provide specific information\nabout the problem.\n\n**Example:**\n\n* Clauses that do not specify an exception class\n* Clauses that are specified as `Exception`" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyBroadException", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyTypeCheckerInspection", + "shortDescription": { + "text": "Incorrect type" + }, + "fullDescription": { + "text": "Reports type errors in function call expressions, targets, and return values. In a dynamically typed language, this is possible in a limited number of cases. Types of function parameters can be specified in docstrings or in Python 3 function annotations. Example: 'def foo() -> int:\n return \"abc\" # Expected int, got str\n\n\na: str\na = foo() # Expected str, got int' With the quick-fix, you can modify the problematic types: 'def foo() -> str:\n return \"abc\"\n\n\na: str\na = foo()'", + "markdown": "Reports type errors in function call expressions, targets, and return values. In a dynamically typed language, this is possible in a limited number of cases.\n\nTypes of function parameters can be specified in\ndocstrings or in Python 3 function annotations.\n\n**Example:**\n\n\n def foo() -> int:\n return \"abc\" # Expected int, got str\n\n\n a: str\n a = foo() # Expected str, got int\n\nWith the quick-fix, you can modify the problematic types:\n\n\n def foo() -> str:\n return \"abc\"\n\n\n a: str\n a = foo()\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyTypeChecker", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyPropertyAccessInspection", + "shortDescription": { + "text": "Inappropriate access to properties" + }, + "fullDescription": { + "text": "Reports cases when properties are accessed inappropriately: Read-only properties are set Write-only properties are read Non-deletable properties are deleted Example: 'class MyClass:\n @property\n def read_only(self): return None\n\n def __write_only_setter(self, value): pass\n\n write_only = property(None, __write_only_setter)\n\n\na = MyClass()\na.read_only = 10 # property cannot be set\ndel a.read_only # property cannot be deleted\nprint(a.write_only) # property cannot be read'", + "markdown": "Reports cases when properties are accessed inappropriately:\n\n* Read-only properties are set\n* Write-only properties are read\n* Non-deletable properties are deleted\n\n**Example:**\n\n\n class MyClass:\n @property\n def read_only(self): return None\n\n def __write_only_setter(self, value): pass\n\n write_only = property(None, __write_only_setter)\n\n\n a = MyClass()\n a.read_only = 10 # property cannot be set\n del a.read_only # property cannot be deleted\n print(a.write_only) # property cannot be read\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyPropertyAccess", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyStubPackagesAdvertiser", + "shortDescription": { + "text": "Stub packages advertiser" + }, + "fullDescription": { + "text": "Reports availability of stub packages. Stub package is a package that contains type information for the corresponding runtime package. Using stub packages ensures better coding assistance for the corresponding python package.", + "markdown": "Reports availability of stub packages.\n\n\n[Stub package](https://www.python.org/dev/peps/pep-0561/) is a package that contains type information for the corresponding\nruntime package.\n\nUsing stub packages ensures better coding assistance for the corresponding python package." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyStubPackagesAdvertiser", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyByteLiteralInspection", + "shortDescription": { + "text": "A byte literal contains a non-ASCII character" + }, + "fullDescription": { + "text": "Reports characters in byte literals that are outside ASCII range. Example: 's = b'№5''", + "markdown": "Reports characters in byte literals that are outside ASCII range.\n\n**Example:**\n\n\n s = b'№5'\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyByteLiteral", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyRelativeImportInspection", + "shortDescription": { + "text": "Suspicious relative imports" + }, + "fullDescription": { + "text": "Reports usages of relative imports inside plain directories, for example, directories neither containing '__init__.py' nor explicitly marked as namespace packages.", + "markdown": "Reports usages of relative imports inside plain directories, for example, directories neither containing `__init__.py` nor\nexplicitly marked as namespace packages." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyPackages", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyAugmentAssignmentInspection", + "shortDescription": { + "text": "Assignment can be replaced with augmented assignment" + }, + "fullDescription": { + "text": "Reports assignments that can be replaced with augmented assignments. Example: 'a = 23\nb = 3\na = a + b' After the quick-fix is applied, the code changes to: 'a = 23\nb = 3\na += b'", + "markdown": "Reports assignments that can be replaced with augmented assignments.\n\n**Example:**\n\n\n a = 23\n b = 3\n a = a + b\n\nAfter the quick-fix is applied, the code changes to:\n\n\n a = 23\n b = 3\n a += b\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "PyAugmentAssignment", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDeprecationInspection", + "shortDescription": { + "text": "Deprecated function, class, or module" + }, + "fullDescription": { + "text": "Reports usages of Python functions, or methods that are marked as deprecated and raise the 'DeprecationWarning' or 'PendingDeprecationWarning' warning. Also, this inspection highlights usages of 'abc.abstractstaticmethod', 'abc.abstractproperty', and 'abc.abstractclassmethod' decorators. Example: 'class Foo:\n @property\n def bar(self):\n import warnings\n warnings.warn(\"this is deprecated\", DeprecationWarning, 2)\n return 5\n\n\nfoo = Foo()\nprint(foo.bar)'", + "markdown": "Reports usages of Python functions, or methods that are marked as\ndeprecated and raise the `DeprecationWarning` or `PendingDeprecationWarning` warning.\n\nAlso, this inspection highlights usages of `abc.abstractstaticmethod`, `abc.abstractproperty`, and `abc.abstractclassmethod`\ndecorators.\n\n**Example:**\n\n\n class Foo:\n @property\n def bar(self):\n import warnings\n warnings.warn(\"this is deprecated\", DeprecationWarning, 2)\n return 5\n\n\n foo = Foo()\n print(foo.bar)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDeprecation", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyUnnecessaryBackslashInspection", + "shortDescription": { + "text": "Unnecessary backslash" + }, + "fullDescription": { + "text": "Reports backslashes in places where line continuation is implicit inside '()', '[]', and '{}'. Example: 'a = ('first', \\\n 'second', 'third')' When the quick-fix is applied, the redundant backslash is deleted.", + "markdown": "Reports backslashes in places where line continuation is implicit inside `()`,\n`[]`, and `{}`.\n\n**Example:**\n\n\n a = ('first', \\\n 'second', 'third')\n\nWhen the quick-fix is applied, the redundant backslash is deleted." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyUnnecessaryBackslash", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyRedeclarationInspection", + "shortDescription": { + "text": "Redeclared names without usages" + }, + "fullDescription": { + "text": "Reports unconditional redeclarations of names without being used in between. Example: 'def x(): pass\n\n\nx = 2' It applies to function and class declarations, and top-level assignments. When the warning is shown, you can try a recommended action, for example, you might be prompted to rename the variable.", + "markdown": "Reports unconditional redeclarations of names without being used in between.\n\n**Example:**\n\n\n def x(): pass\n\n\n x = 2\n\nIt applies to function and class declarations, and top-level assignments.\n\nWhen the warning is shown, you can try a recommended action, for example, you might be prompted to\nrename the variable." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyRedeclaration", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyShadowingNamesInspection", + "shortDescription": { + "text": "Shadowing names from outer scopes" + }, + "fullDescription": { + "text": "Reports shadowing names defined in outer scopes. Example: 'def outer(p):\n def inner(p):\n pass' As a quick-fix, the IDE offers to remove a parameter or rename it.", + "markdown": "Reports shadowing names defined in outer scopes.\n\n**Example:**\n\n\n def outer(p):\n def inner(p):\n pass\n\nAs a quick-fix, the IDE offers to remove a parameter or rename it." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyShadowingNames", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyFinalInspection", + "shortDescription": { + "text": "Invalid usages of final classes, methods, and variables" + }, + "fullDescription": { + "text": "Reports invalid usages of final classes, methods and variables. Example: 'from typing import final\n\n\n@final\nclass A:\n def a_method(self):\n pass\n\n\nclass B(A):\n def a_method(self):\n pass'", + "markdown": "Reports invalid usages of final classes,\nmethods and variables.\n\n**Example:**\n\n\n from typing import final\n\n\n @final\n class A:\n def a_method(self):\n pass\n\n\n class B(A):\n def a_method(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyFinal", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyStubPackagesCompatibilityInspection", + "shortDescription": { + "text": "Incompatible stub packages" + }, + "fullDescription": { + "text": "Reports stub packages that do not support the version of the corresponding runtime package. A stub package contains type information for some runtime package.", + "markdown": "Reports stub packages that do not support the version of the corresponding runtime package.\n\nA [stub package](https://www.python.org/dev/peps/pep-0561/) contains type information for some runtime package." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyStubPackagesCompatibility", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyProtectedMemberInspection", + "shortDescription": { + "text": "Accessing a protected member of a class or a module" + }, + "fullDescription": { + "text": "Reports cases when a protected member is accessed outside the class, a descendant of the class where it is defined, or a module. Example: 'class Foo:\n def _protected_method(self):\n pass\n\n\nclass Bar(Foo):\n def public_method(self):\n self._protected_method()\n\n\nfoo = Foo()\nfoo._protected_method() # Access to a protected method'", + "markdown": "Reports cases when a protected member is accessed outside the class,\na descendant of the class where it is defined, or a module.\n\n**Example:**\n\n\n class Foo:\n def _protected_method(self):\n pass\n\n\n class Bar(Foo):\n def public_method(self):\n self._protected_method()\n\n\n foo = Foo()\n foo._protected_method() # Access to a protected method\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyProtectedMember", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyUnboundLocalVariableInspection", + "shortDescription": { + "text": "Unbound local variables" + }, + "fullDescription": { + "text": "Reports local variables referenced before assignment. Example: 'x = 0\nif x > 10:\n b = 3\nprint(b)' The IDE reports a problem for 'print(b)'. A possible fix is: 'x = 0\nif x > 10:\n b = 3\n print(b)'", + "markdown": "Reports local variables referenced before assignment.\n\n**Example:**\n\n\n x = 0\n if x > 10:\n b = 3\n print(b)\n\nThe IDE reports a problem for `print(b)`. A possible fix is:\n\n\n x = 0\n if x > 10:\n b = 3\n print(b)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyUnboundLocalVariable", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyNamedTupleInspection", + "shortDescription": { + "text": "Invalid definition of 'typing.NamedTuple'" + }, + "fullDescription": { + "text": "Reports invalid definition of a typing.NamedTuple. Example: 'import typing\n\n\nclass FullName(typing.NamedTuple):\n first: str\n last: str = \"\"\n middle: str' As a fix, place the field with the default value after the fields without default values: 'import typing\n\n\nclass FullName(typing.NamedTuple):\n first: str\n middle: str\n last: str = \"\"'", + "markdown": "Reports invalid definition of a\n[typing.NamedTuple](https://docs.python.org/3/library/typing.html#typing.NamedTuple).\n\n**Example:**\n\n\n import typing\n\n\n class FullName(typing.NamedTuple):\n first: str\n last: str = \"\"\n middle: str\n\nAs a fix, place the field with the default value after the fields without default values:\n\n\n import typing\n\n\n class FullName(typing.NamedTuple):\n first: str\n middle: str\n last: str = \"\"\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyNamedTuple", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PySingleQuotedDocstringInspection", + "shortDescription": { + "text": "Single quoted docstring" + }, + "fullDescription": { + "text": "Reports docstrings that do not adhere to the triple double-quoted string format. Example: 'def calc(self, balance=0):\n 'param: balance'\n self.balance = balance' When the quick-fix is applied, the code changes to: 'def calc(self, balance=0):\n \"\"\"param: balance\"\"\"\n self.balance = balance'", + "markdown": "Reports docstrings that do not adhere to the triple double-quoted string format.\n\n**Example:**\n\n\n def calc(self, balance=0):\n 'param: balance'\n self.balance = balance\n\nWhen the quick-fix is applied, the code changes to:\n\n\n def calc(self, balance=0):\n \"\"\"param: balance\"\"\"\n self.balance = balance\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PySingleQuotedDocstring", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyUnusedLocalInspection", + "shortDescription": { + "text": "Unused local symbols" + }, + "fullDescription": { + "text": "Reports local variables, parameters, and functions that are locally defined, but not used name in a function.", + "markdown": "Reports local variables, parameters, and functions that are locally defined, but not used name in a function." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyUnusedLocal", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyReturnFromInitInspection", + "shortDescription": { + "text": "__init__ method that returns a value" + }, + "fullDescription": { + "text": "Reports occurrences of 'return' statements with a return value inside '__init__' methods of classes. Example: 'class Sum:\n def __init__(self, a, b):\n self.a = a\n self.b = b\n self.sum = a + b\n return self.sum' A constructor should not return any value. The '__init__' method should only initialize the values of instance members for news objects. As a quick-fix, the IDE offers to remove the 'return' statement.", + "markdown": "Reports occurrences of `return` statements with a return value inside\n`__init__` methods of classes.\n\n**Example:**\n\n\n class Sum:\n def __init__(self, a, b):\n self.a = a\n self.b = b\n self.sum = a + b\n return self.sum\n\nA constructor should not return any value. The `__init__` method should\nonly initialize the values of instance members for news objects.\n\nAs a quick-fix, the IDE offers to remove the `return` statement." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyReturnFromInit", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyNestedDecoratorsInspection", + "shortDescription": { + "text": "Problematic nesting of decorators" + }, + "fullDescription": { + "text": "Reports problems with nesting decorators. The inspection highlights the cases when 'classmethod' or 'staticmethod' is applied before another decorator. Example: 'def innocent(f):\n return f\n\n\nclass A:\n @innocent # Decorator will not receive a callable it may expect\n @classmethod\n def f2(cls):\n pass\n\n @innocent # Decorator will not receive a callable it may expect\n @staticmethod\n def f1():\n pass' As a quick-fix, the IDE offers to remove the decorator.", + "markdown": "Reports problems with nesting decorators. The inspection highlights the cases when `classmethod` or `staticmethod`\nis applied before another decorator.\n\n**Example:**\n\n\n def innocent(f):\n return f\n\n\n class A:\n @innocent # Decorator will not receive a callable it may expect\n @classmethod\n def f2(cls):\n pass\n\n @innocent # Decorator will not receive a callable it may expect\n @staticmethod\n def f1():\n pass\n\nAs a quick-fix, the IDE offers to remove the decorator." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyNestedDecorators", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyMissingOrEmptyDocstringInspection", + "shortDescription": { + "text": "Missing or empty docstring" + }, + "fullDescription": { + "text": "Reports missing and empty docstrings. Example of a missing docstring 'def demo(a):\n c = a ** 2' Example of an empty docstring 'def demo(a):\n \"\"\"\n \"\"\"\n c = a ** 2' When the quick-fix is applied, the code fragments change to: 'def demo(a):\n \"\"\"\n\n :param a:\n \"\"\"\n c = a ** 2' You need to provide some details about the parameter in the generated template.", + "markdown": "Reports missing and empty docstrings.\n\n**Example of a missing docstring**\n\n\n def demo(a):\n c = a ** 2\n\n**Example of an empty docstring**\n\n\n def demo(a):\n \"\"\"\n \"\"\"\n c = a ** 2\n\nWhen the quick-fix is applied, the code fragments change to:\n\n\n def demo(a):\n \"\"\"\n\n :param a:\n \"\"\"\n c = a ** 2\n\nYou need to provide some details about the parameter in the generated template." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "PyMissingOrEmptyDocstring", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyOverloadsInspection", + "shortDescription": { + "text": "Overloads in regular Python files" + }, + "fullDescription": { + "text": "Reports cases when overloads in regular Python files are placed after the implementation or when their signatures are not compatible with the implementation. Example: 'from typing import overload\n\n\n@overload\ndef foo(p1, p2): # Overload signature is not compatible with the implementation\n pass\n\n\n@overload\ndef foo(p1): # Overload signature is not compatible with the implementation\n pass\n\n\ndef foo(p1, p2, p3):\n print(p1, p2, p3)'", + "markdown": "Reports cases when overloads in regular Python files are placed after the implementation or when their signatures are\nnot compatible with the implementation.\n\n**Example:**\n\n\n from typing import overload\n\n\n @overload\n def foo(p1, p2): # Overload signature is not compatible with the implementation\n pass\n\n\n @overload\n def foo(p1): # Overload signature is not compatible with the implementation\n pass\n\n\n def foo(p1, p2, p3):\n print(p1, p2, p3)\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyOverloads", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyPep8NamingInspection", + "shortDescription": { + "text": "PEP 8 naming convention violation" + }, + "fullDescription": { + "text": "Reports violations of the PEP8 naming conventions. Example: 'class mammalia(object):\n extremities = 4\n\n def feeds(self):\n print(\"milk\")' In this code fragment, IDE offers to rename 'mammalia' to 'Mammalia'. When the quick-fix is applied, the code change to: 'class Mammalia(object):\n extremities = 4\n\n def feeds(self):\n print(\"milk\")'", + "markdown": "Reports violations of the\n[PEP8](https://www.python.org/dev/peps/pep-0008/) naming conventions.\n\n**Example:**\n\n\n class mammalia(object):\n extremities = 4\n\n def feeds(self):\n print(\"milk\")\n\nIn this code fragment, IDE offers to rename `mammalia` to `Mammalia`.\nWhen the quick-fix is applied, the code change to:\n\n\n class Mammalia(object):\n extremities = 4\n\n def feeds(self):\n print(\"milk\")\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyPep8Naming", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDictDuplicateKeysInspection", + "shortDescription": { + "text": "Dictionary contains duplicate keys" + }, + "fullDescription": { + "text": "Reports using the same value as the dictionary key twice. Example: 'dic = {\"a\": [1, 2], \"a\": [3, 4]}'", + "markdown": "Reports using the same value as the dictionary key twice.\n\n**Example:**\n\n\n dic = {\"a\": [1, 2], \"a\": [3, 4]}\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDictDuplicateKeys", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyExceptClausesOrderInspection", + "shortDescription": { + "text": "Wrong order of 'except' clauses" + }, + "fullDescription": { + "text": "Reports cases when 'except' clauses are not in the proper order, from the more specific to the more generic, or one exception class is caught twice. If you do not fix the order, some exceptions may not be caught by the most specific handler. Example: 'try:\n call()\nexcept ValueError:\n pass\nexcept UnicodeError:\n pass' The IDE recommends moving the clause up. When the quick-fix is applied, the code changes to: 'try:\n call()\nexcept UnicodeError:\n pass\nexcept ValueError:\n pass'", + "markdown": "Reports cases when `except` clauses are not in the proper order,\nfrom the more specific to the more generic, or one exception class is caught twice.\n\n\nIf you do not fix the order, some exceptions may not be caught by the most specific handler.\n\n**Example:**\n\n\n try:\n call()\n except ValueError:\n pass\n except UnicodeError:\n pass\n\nThe IDE recommends moving the clause up. When the quick-fix is applied, the code changes to:\n\n\n try:\n call()\n except UnicodeError:\n pass\n except ValueError:\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyExceptClausesOrder", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyDataclassInspection", + "shortDescription": { + "text": "Invalid definition and usage of Data Classes" + }, + "fullDescription": { + "text": "Reports invalid definitions and usages of classes created with 'dataclasses' or 'attr' modules. Example: 'import dataclasses\n\n\n@dataclasses.dataclass\nclass FullName:\n first: str\n middle: str = \"\"\n last: str'", + "markdown": "Reports invalid definitions and usages of classes created with\n`dataclasses` or `attr` modules.\n\n**Example:**\n\n\n import dataclasses\n\n\n @dataclasses.dataclass\n class FullName:\n first: str\n middle: str = \"\"\n last: str\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyDataclass", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyClassicStyleClassInspection", + "shortDescription": { + "text": "Classic style class usage" + }, + "fullDescription": { + "text": "Reports classic style classes usage. This inspection applies only to Python 2. Example: 'class A:\n pass' With quick-fixes provided by the IDE, this code fragment changes to: 'class A(object):\n def __init__(self):\n pass'", + "markdown": "Reports [classic style classes](https://docs.python.org/2/reference/datamodel.html#new-style-and-classic-classes) usage. This inspection applies only to Python 2.\n\n**Example:**\n\n\n class A:\n pass\n\nWith quick-fixes provided by the IDE, this code fragment changes to:\n\n\n class A(object):\n def __init__(self):\n pass\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "PyClassicStyleClass", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyNoneFunctionAssignmentInspection", + "shortDescription": { + "text": "Assigning function calls that don't return anything" + }, + "fullDescription": { + "text": "Reports cases when an assignment is done on a function that does not return anything. This inspection is similar to pylint inspection E1111. Example: 'def just_print():\n print(\"Hello!\")\n\n\naction = just_print()' As a quick-fix, the IDE offers to remove the assignment.", + "markdown": "Reports cases when an assignment is done on a function that does not return anything.\nThis inspection is similar to [pylint inspection E1111](https://docs.pylint.org/en/1.6.0/features.html#id6).\n\n**Example:**\n\n\n def just_print():\n print(\"Hello!\")\n\n\n action = just_print()\n\nAs a quick-fix, the IDE offers to remove the assignment." + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyNoneFunctionAssignment", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyPropertyDefinitionInspection", + "shortDescription": { + "text": "Incorrect property definition" + }, + "fullDescription": { + "text": "Reports problems with the arguments of 'property()' and functions annotated with '@property'. 'class C:\n @property\n def abc(self): # Getter should return or yield something\n pass\n\n @abc.setter\n def foo(self, value): # Names of function and decorator don't match\n pass\n\n @abc.setter\n def abc(self, v1, v2): # Setter signature should be (self, value)\n pass\n\n @abc.deleter\n def abc(self, v1): # Delete signature should be (self)\n pass' A quick-fix offers to update parameters.", + "markdown": "Reports problems with the arguments of `property()` and functions\nannotated with `@property`.\n\n\n class C:\n @property\n def abc(self): # Getter should return or yield something\n pass\n\n @abc.setter\n def foo(self, value): # Names of function and decorator don't match\n pass\n\n @abc.setter\n def abc(self, v1, v2): # Setter signature should be (self, value)\n pass\n\n @abc.deleter\n def abc(self, v1): # Delete signature should be (self)\n pass\n\nA quick-fix offers to update parameters." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyPropertyDefinition", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyIncorrectDocstringInspection", + "shortDescription": { + "text": "Incorrect docstring" + }, + "fullDescription": { + "text": "Reports mismatched parameters in a docstring. For example, 'b' is highlighted, because there is no such a parameter in the 'add' function. 'def add(a, c):\n \"\"\"\n @param a:\n @param b:\n @return:\n \"\"\"\n pass' The inspection does not warn you of missing parameters if none of them is mentioned in a docstring: 'def mult(a, c):\n \"\"\"\n @return:\n \"\"\"\n pass'", + "markdown": "Reports mismatched parameters in a docstring. For example, `b` is highlighted, because there is no\nsuch a parameter in the `add` function.\n\n\n def add(a, c):\n \"\"\"\n @param a:\n @param b:\n @return:\n \"\"\"\n pass\n\nThe inspection does not warn you of missing parameters if none of them is mentioned in a docstring:\n\n\n def mult(a, c):\n \"\"\"\n @return:\n \"\"\"\n pass\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyIncorrectDocstring", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "PyListCreationInspection", + "shortDescription": { + "text": "Non-optimal list declaration" + }, + "fullDescription": { + "text": "Reports cases when a list declaration can be rewritten with a list literal. This ensures better performance of your application. Example: 'l = [1]\nl.append(2)' When the quick-fix is applied, the code changes to: 'l = [1, 2]'", + "markdown": "Reports cases when a list declaration\ncan be rewritten with a list literal.\n\nThis ensures better performance of your application.\n\n**Example:**\n\n\n l = [1]\n l.append(2)\n\nWhen the quick-fix is applied, the code changes to:\n\n\n l = [1, 2]\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "PyListCreation", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Python", + "index": 0, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.editorconfig.editorconfigjetbrains", + "version": "241.17890.14", + "rules": [ + { + "id": "EditorConfigCharClassRedundancy", + "shortDescription": { + "text": "Unnecessary character class" + }, + "fullDescription": { + "text": "Reports character classes that consist of a single character. Such classes can be simplified to a character, for example '[a]'→'a'.", + "markdown": "Reports character classes that consist of a single character. Such classes can be simplified to a character, for example `[a]`→`a`." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigCharClassRedundancy", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigDeprecatedDescriptor", + "shortDescription": { + "text": "Deprecated property" + }, + "fullDescription": { + "text": "Reports EditorConfig properties that are no longer supported.", + "markdown": "Reports EditorConfig properties that are no longer supported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigDeprecatedDescriptor", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigRootDeclarationUniqueness", + "shortDescription": { + "text": "Extra top-level declaration" + }, + "fullDescription": { + "text": "Reports multiple top-level declarations. There can be only one optional “root=true” top-level declaration in the EditorConfig file. Using multiple top-level declarations is not allowed.", + "markdown": "Reports multiple top-level declarations. There can be only one optional \"root=true\" top-level declaration in the EditorConfig file. Using multiple top-level declarations is not allowed." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigRootDeclarationUniqueness", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigNumerousWildcards", + "shortDescription": { + "text": "Too many wildcards" + }, + "fullDescription": { + "text": "Reports sections that contain too many wildcards. Using a lot of wildcards may lead to performance issues.", + "markdown": "Reports sections that contain too many wildcards. Using a lot of wildcards may lead to performance issues." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "EditorConfigNumerousWildcards", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigWildcardRedundancy", + "shortDescription": { + "text": "Redundant wildcard" + }, + "fullDescription": { + "text": "Reports wildcards that become redundant when the “**” wildcard is used in the same section. The “**” wildcard defines a broader set of files than any other wildcard. That is why, any other wildcard used in the same section has no affect and can be removed.", + "markdown": "Reports wildcards that become redundant when the \"\\*\\*\" wildcard is used in the same section.\n\n\nThe \"\\*\\*\" wildcard defines a broader set of files than any other wildcard.\nThat is why, any other wildcard used in the same section has no affect and can be removed." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigWildcardRedundancy", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigPartialOverride", + "shortDescription": { + "text": "Overlapping sections" + }, + "fullDescription": { + "text": "Reports subsets of files specified in the current section that overlap with other subsets in other sections. For example: '[{foo,bar}]' and '[{foo,bas}]' both contain “foo”.", + "markdown": "Reports subsets of files specified in the current section that overlap with other subsets in other sections. For example: `[{foo,bar}]` and `[{foo,bas}]` both contain \"foo\"." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "EditorConfigPartialOverride", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigEmptySection", + "shortDescription": { + "text": "Empty section" + }, + "fullDescription": { + "text": "Reports sections that do not contain any EditorConfig properties.", + "markdown": "Reports sections that do not contain any EditorConfig properties." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigEmptySection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigHeaderUniqueness", + "shortDescription": { + "text": "EditorConfig section is not unique" + }, + "fullDescription": { + "text": "Reports sections that define the same file pattern as other sections.", + "markdown": "Reports sections that define the same file pattern as other sections." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigHeaderUniqueness", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigShadowingOption", + "shortDescription": { + "text": "Overriding property" + }, + "fullDescription": { + "text": "Reports properties that override the same properties defined earlier in the file. For example: '[*.java]\nindent_size=4\n[{*.java,*.js}]\nindent_size=2' The second section includes the same files as '[*.java]' but also sets indent_size to value 2. Thus the first declaration 'indent_size=4'will be ignored.", + "markdown": "Reports properties that override the same properties defined earlier in the file.\n\nFor example:\n\n\n [*.java]\n indent_size=4\n [{*.java,*.js}]\n indent_size=2\n\nThe second section includes the same files as `[*.java]` but also sets indent_size to value 2. Thus the first declaration `indent_size=4`will be ignored." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigShadowingOption", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigListAcceptability", + "shortDescription": { + "text": "Unexpected value list" + }, + "fullDescription": { + "text": "Reports lists of values that are used in properties in which lists are not supported. In this case, only a single value can be specified.", + "markdown": "Reports lists of values that are used in properties in which lists are not supported. In this case, only a single value can be specified." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigListAcceptability", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigShadowedOption", + "shortDescription": { + "text": "Overridden property" + }, + "fullDescription": { + "text": "Reports properties that are already defined in other sections. For example: '[*.java]\nindent_size=4\n[{*.java,*.js}]\nindent_size=2' The second section includes all '*.java' files too but it also redefines indent_size. As a result the value 2 will be used for files matching '*.java'.", + "markdown": "Reports properties that are already defined in other sections.\n\nFor example:\n\n\n [*.java]\n indent_size=4\n [{*.java,*.js}]\n indent_size=2\n\nThe second section includes all `*.java` files too but it also redefines indent_size. As a result the value 2 will be used for files matching `*.java`." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigShadowedOption", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigEmptyHeader", + "shortDescription": { + "text": "Empty header" + }, + "fullDescription": { + "text": "Reports sections with an empty header. Section header must contain file path globs in the format similar to one supported by 'gitignore'.", + "markdown": "Reports sections with an empty header. Section header must contain file path globs in the format similar to one supported by `gitignore`." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigEmptyHeader", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigValueCorrectness", + "shortDescription": { + "text": "Invalid property value" + }, + "fullDescription": { + "text": "Reports property values that do not meet value restrictions. For example, some properties may be only “true” or “false”, others contain only integer numbers etc. If a value has a limited set of variants, use code completion to see all of them.", + "markdown": "Reports property values that do not meet value restrictions. For example, some properties may be only \"true\" or \"false\", others contain only integer numbers etc. If a value has a limited set of variants, use code completion to see all of them." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigValueCorrectness", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigVerifyByCore", + "shortDescription": { + "text": "Invalid .editorconfig file" + }, + "fullDescription": { + "text": "Verifies the whole file using the backing EditorConfig core library and reports any failures. Any such failure would prevent EditorConfig properties from being correctly applied.", + "markdown": "Verifies the whole file using the backing EditorConfig core library and reports any failures. Any such failure would prevent EditorConfig properties from being correctly applied." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigVerifyByCore", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigValueUniqueness", + "shortDescription": { + "text": "Non-unique list value" + }, + "fullDescription": { + "text": "Reports duplicates in lists of values.", + "markdown": "Reports duplicates in lists of values." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigValueUniqueness", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigMissingRequiredDeclaration", + "shortDescription": { + "text": "Required declarations are missing" + }, + "fullDescription": { + "text": "Reports properties that miss the required declarations. Refer to the documentation for more information.", + "markdown": "Reports properties that miss the required declarations. Refer to the documentation for more information." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigMissingRequiredDeclaration", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigCharClassLetterRedundancy", + "shortDescription": { + "text": "Duplicate character class letter" + }, + "fullDescription": { + "text": "Reports wildcard patterns in the EditorConfig section that contain a duplicate character in the character class, for example '[aa]'.", + "markdown": "Reports wildcard patterns in the EditorConfig section that contain a duplicate character in the character class, for example `[aa]`." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigCharClassLetterRedundancy", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigKeyCorrectness", + "shortDescription": { + "text": "Unknown property" + }, + "fullDescription": { + "text": "Reports properties that are not supported by the IDE. Note: some “ij” domain properties may require specific language plugins.", + "markdown": "Reports properties that are not supported by the IDE. Note: some \"ij\" domain properties may require specific language plugins." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigKeyCorrectness", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigPatternEnumerationRedundancy", + "shortDescription": { + "text": "Unnecessary braces" + }, + "fullDescription": { + "text": "Reports pattern lists that are either empty '{}' or contain just one pattern, for example '{foo}' in contrast to a list containing multiple patterns, for example '{foo,bar}'. In this case braces are handled as a part of the name. For example, the pattern '*.{a}' will match the file 'my.{a}' but not 'my.a'.", + "markdown": "Reports pattern lists that are either empty `{}` or contain just one pattern, for example `{foo}` in contrast to a list containing multiple patterns, for example `{foo,bar}`. In this case braces are handled as a part of the name. For example, the pattern `*.{a}` will match the file `my.{a}` but not `my.a`." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigPatternEnumerationRedundancy", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigEncoding", + "shortDescription": { + "text": "File encoding doesn't match EditorConfig charset" + }, + "fullDescription": { + "text": "Checks that current file encoding matches the encoding defined in \"charset\" property of .editorconfig file.", + "markdown": "Checks that current file encoding matches the encoding defined in \"charset\" property of .editorconfig file." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigEncoding", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigSpaceInHeader", + "shortDescription": { + "text": "Space in file pattern" + }, + "fullDescription": { + "text": "Reports space characters in wildcard patterns that affect pattern matching. If these characters are not intentional, they should be removed.", + "markdown": "Reports space characters in wildcard patterns that affect pattern matching. If these characters are not intentional, they should be removed." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "EditorConfigSpaceInHeader", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigOptionRedundancy", + "shortDescription": { + "text": "Redundant property" + }, + "fullDescription": { + "text": "Reports properties that are redundant when another applicable section already contains the same property and value. For example: '[*]\nindent_size=4\n[*.java]\nindent_size=4' are both applicable to '*.java' files and define the same 'indent_size' value.", + "markdown": "Reports properties that are redundant when another applicable section already contains the same property and value.\n\n\nFor example:\n\n\n [*]\n indent_size=4\n [*.java]\n indent_size=4\n\nare both applicable to `*.java` files and define the same `indent_size` value." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigOptionRedundancy", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigRootDeclarationCorrectness", + "shortDescription": { + "text": "Unexpected top-level declaration" + }, + "fullDescription": { + "text": "Reports unexpected top-level declarations. Top-level declarations other than “root=true” are not allowed in the EditorConfig file.", + "markdown": "Reports unexpected top-level declarations. Top-level declarations other than \"root=true\" are not allowed in the EditorConfig file." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigRootDeclarationCorrectness", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigReferenceCorrectness", + "shortDescription": { + "text": "Invalid reference" + }, + "fullDescription": { + "text": "Reports identifiers that are either unknown or have a wrong type.", + "markdown": "Reports identifiers that are either unknown or have a wrong type." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigReferenceCorrectness", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigUnusedDeclaration", + "shortDescription": { + "text": "Unused declaration" + }, + "fullDescription": { + "text": "Reports unused declarations. Such declarations can be removed.", + "markdown": "Reports unused declarations. Such declarations can be removed." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigUnusedDeclaration", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigPairAcceptability", + "shortDescription": { + "text": "Unexpected key-value pair" + }, + "fullDescription": { + "text": "Reports key-value pairs that are not allowed in the current context.", + "markdown": "Reports key-value pairs that are not allowed in the current context." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigPairAcceptability", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigPatternRedundancy", + "shortDescription": { + "text": "Duplicate or redundant pattern" + }, + "fullDescription": { + "text": "Reports file patterns that are redundant as there already are other patterns that define the same scope of files or even a broader one. For example, in '[{*.java,*}]' the first '*.java' pattern defines a narrower scope compared to '*'. That is why it is redundant and can be removed.", + "markdown": "Reports file patterns that are redundant as there already are other patterns that define the same scope of files or even a broader one. For example, in `[{*.java,*}]` the first `*.java` pattern defines a narrower scope compared to `*`. That is why it is redundant and can be removed." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigPatternRedundancy", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigNoMatchingFiles", + "shortDescription": { + "text": "No matching files" + }, + "fullDescription": { + "text": "Reports sections with wildcard patterns that do not match any files under the directory in which the '.editorconfig' file is located.", + "markdown": "Reports sections with wildcard patterns that do not match any files under the directory in which the `.editorconfig` file is located." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EditorConfigNoMatchingFiles", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EditorConfigUnexpectedComma", + "shortDescription": { + "text": "Unexpected comma" + }, + "fullDescription": { + "text": "Reports commas that cannot be used in the current context. Commas are allowed only as separators for values in lists.", + "markdown": "Reports commas that cannot be used in the current context. Commas are allowed only as separators for values in lists." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "EditorConfigUnexpectedComma", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "EditorConfig", + "index": 1, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "com.jetbrains.sh", + "version": "241.17890.14", + "rules": [ + { + "id": "ShellCheck", + "shortDescription": { + "text": "ShellCheck" + }, + "fullDescription": { + "text": "Reports shell script bugs detected by the integrated ShellCheck static analysis tool.", + "markdown": "Reports shell script bugs detected by the integrated [ShellCheck](https://github.com/koalaman/shellcheck) static analysis tool." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "ShellCheck", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "Shell script", + "index": 2, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "com.intellij", + "version": "241.17890.14", + "rules": [ + { + "id": "XmlHighlighting", + "shortDescription": { + "text": "XML highlighting" + }, + "fullDescription": { + "text": "Reports XML validation problems in the results of a batch code inspection.", + "markdown": "Reports XML validation problems in the results of a batch code inspection." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlHighlighting", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "JsonSchemaDeprecation", + "shortDescription": { + "text": "Deprecated JSON property" + }, + "fullDescription": { + "text": "Reports a deprecated property in a JSON file. Note that deprecation mechanism is not defined in the JSON Schema specification yet, and this inspection uses a non-standard extension 'deprecationMessage'.", + "markdown": "Reports a deprecated property in a JSON file. \nNote that deprecation mechanism is not defined in the JSON Schema specification yet, and this inspection uses a non-standard extension 'deprecationMessage'." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "JsonSchemaDeprecation", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlDuplicatedId", + "shortDescription": { + "text": "Duplicate 'id' attribute" + }, + "fullDescription": { + "text": "Reports a duplicate 'id' attribute in XML.", + "markdown": "Reports a duplicate `id` attribute in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlDuplicatedId", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpDuplicateCharacterInClass", + "shortDescription": { + "text": "Duplicate character in character class" + }, + "fullDescription": { + "text": "Reports duplicate characters inside a RegExp character class. Duplicate characters are unnecessary and can be removed without changing the semantics of the regex. Example: '[aabc]' After the quick-fix is applied: '[abc]'", + "markdown": "Reports duplicate characters inside a RegExp character class. Duplicate characters are unnecessary and can be removed without changing the semantics of the regex.\n\n**Example:**\n\n\n [aabc]\n\nAfter the quick-fix is applied:\n\n\n [abc]\n" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpDuplicateCharacterInClass", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "JsonSchemaRefReference", + "shortDescription": { + "text": "Unresolved '$ref' and '$schema' references" + }, + "fullDescription": { + "text": "Reports an unresolved '$ref' or '$schema' path in a JSON schema.", + "markdown": "Reports an unresolved `$ref` or `$schema` path in a JSON schema. " + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "JsonSchemaRefReference", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlUnknownBooleanAttribute", + "shortDescription": { + "text": "Incorrect boolean attribute" + }, + "fullDescription": { + "text": "Reports an HTML non-boolean attribute without a value. Suggests configuring attributes that should not be reported.", + "markdown": "Reports an HTML non-boolean attribute without a value. Suggests configuring attributes that should not be reported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlUnknownBooleanAttribute", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlInvalidId", + "shortDescription": { + "text": "Unresolved 'id' reference" + }, + "fullDescription": { + "text": "Reports an unresolved 'id' reference in XML.", + "markdown": "Reports an unresolved `id` reference in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlInvalidId", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlUnboundNsPrefix", + "shortDescription": { + "text": "Unbound namespace prefix" + }, + "fullDescription": { + "text": "Reports an unbound namespace prefix in XML.", + "markdown": "Reports an unbound namespace prefix in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "XmlUnboundNsPrefix", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RequiredAttributes", + "shortDescription": { + "text": "Missing required attribute" + }, + "fullDescription": { + "text": "Reports a missing mandatory attribute in an XML/HTML tag. Suggests configuring attributes that should not be reported.", + "markdown": "Reports a missing mandatory attribute in an XML/HTML tag. Suggests configuring attributes that should not be reported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "RequiredAttributes", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "InconsistentLineSeparators", + "shortDescription": { + "text": "Inconsistent line separators" + }, + "fullDescription": { + "text": "Reports files with line separators different from the ones that are specified in the project's settings. For example, the inspection will be triggered if you set the line separator to '\\n' in Settings | Editor | Code Style | Line separator, while the file you are editing uses '\\r\\n' as a line separator. The inspection also warns you about mixed line separators within a file.", + "markdown": "Reports files with line separators different from the ones that are specified in the project's settings.\n\nFor example, the inspection will be triggered if you set the line separator to `\\n` in\n[Settings \\| Editor \\| Code Style \\| Line separator](settings://preferences.sourceCode?Line%20separator),\nwhile the file you are editing uses `\\r\\n` as a line separator.\n\nThe inspection also warns you about mixed line separators within a file." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "InconsistentLineSeparators", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "ReassignedToPlainText", + "shortDescription": { + "text": "Reassigned to plain text" + }, + "fullDescription": { + "text": "Reports files that were explicitly re-assigned to Plain Text File Type. This association is unnecessary because the platform auto-detects text files by content automatically. You can dismiss this warning by removing the file type association in Settings | Editor | File Types | Text.", + "markdown": "Reports files that were explicitly re-assigned to Plain Text File Type. This association is unnecessary because the platform auto-detects text files by content automatically.\n\nYou can dismiss this warning by removing the file type association\nin **Settings \\| Editor \\| File Types \\| Text**." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "ReassignedToPlainText", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RedundantSuppression", + "shortDescription": { + "text": "Redundant suppression" + }, + "fullDescription": { + "text": "Reports usages of the following elements that can be safely removed because the inspection they affect is no longer applicable in this context: '@SuppressWarning' annotation, or '// noinspection' line comment, or '/** noinspection */' JavaDoc comment Example: 'public class C {\n // symbol is already private,\n // but annotation is still around\n @SuppressWarnings({\"WeakerAccess\"})\n private boolean CONST = true;\n void f() {\n CONST = false;\n }\n}'", + "markdown": "Reports usages of the following elements that can be safely removed because the inspection they affect is no longer applicable in this context:\n\n* `@SuppressWarning` annotation, or\n* `// noinspection` line comment, or\n* `/** noinspection */` JavaDoc comment\n\nExample:\n\n\n public class C {\n // symbol is already private,\n // but annotation is still around\n @SuppressWarnings({\"WeakerAccess\"})\n private boolean CONST = true;\n void f() {\n CONST = false;\n }\n }\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "RedundantSuppression", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "ProblematicWhitespace", + "shortDescription": { + "text": "Problematic whitespace" + }, + "fullDescription": { + "text": "Reports the following problems: Tabs used for indentation when the code style is configured to use only spaces. Spaces used for indentation when the code style is configured to use only tabs. Spaces used for indentation and tabs used for alignment when the code style is configured to use smart tabs.", + "markdown": "Reports the following problems:\n\n* Tabs used for indentation when the code style is configured to use only spaces.\n* Spaces used for indentation when the code style is configured to use only tabs.\n* Spaces used for indentation and tabs used for alignment when the code style is configured to use smart tabs." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "ProblematicWhitespace", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlUnknownTarget", + "shortDescription": { + "text": "Unresolved file in a link" + }, + "fullDescription": { + "text": "Reports an unresolved file in a link.", + "markdown": "Reports an unresolved file in a link." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlUnknownTarget", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "LongLine", + "shortDescription": { + "text": "Line is longer than allowed by code style" + }, + "fullDescription": { + "text": "Reports lines that are longer than the Hard wrap at parameter specified in Settings | Editor | Code Style | General.", + "markdown": "Reports lines that are longer than the **Hard wrap at** parameter specified in [Settings \\| Editor \\| Code Style \\| General](settings://preferences.sourceCode?Hard%20wrap%20at)." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "LongLine", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlUnusedNamespaceDeclaration", + "shortDescription": { + "text": "Unused schema declaration" + }, + "fullDescription": { + "text": "Reports an unused namespace declaration or location hint in XML.", + "markdown": "Reports an unused namespace declaration or location hint in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "XmlUnusedNamespaceDeclaration", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpRedundantClassElement", + "shortDescription": { + "text": "Redundant '\\d', '[:digit:]', or '\\D' class elements" + }, + "fullDescription": { + "text": "Reports redundant '\\d' or '[:digit:]' that are used in one class with '\\w' or '[:word:]' ('\\D' with '\\W') and can be removed. Example: '[\\w\\d]' After the quick-fix is applied: '[\\w]' New in 2022.2", + "markdown": "Reports redundant `\\d` or `[:digit:]` that are used in one class with `\\w` or `[:word:]` (`\\D` with `\\W`) and can be removed.\n\n**Example:**\n\n\n [\\w\\d]\n\nAfter the quick-fix is applied:\n\n\n [\\w]\n\nNew in 2022.2" + }, + "defaultConfiguration": { + "enabled": true, + "level": "note", + "parameters": { + "suppressToolId": "RegExpRedundantClassElement", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpSimplifiable", + "shortDescription": { + "text": "Regular expression can be simplified" + }, + "fullDescription": { + "text": "Reports regular expressions that can be simplified. Example: '[a] xx* [ah-hz]' After the quick-fix is applied: 'a x+ [ahz]' New in 2022.1", + "markdown": "Reports regular expressions that can be simplified.\n\n**Example:**\n\n\n [a] xx* [ah-hz]\n\nAfter the quick-fix is applied:\n\n\n a x+ [ahz]\n\nNew in 2022.1" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "RegExpSimplifiable", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlWrongRootElement", + "shortDescription": { + "text": "Wrong root element" + }, + "fullDescription": { + "text": "Reports a root tag name different from the name specified in the '' tag.", + "markdown": "Reports a root tag name different from the name specified in the `` tag." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlWrongRootElement", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpEmptyAlternationBranch", + "shortDescription": { + "text": "Empty branch in alternation" + }, + "fullDescription": { + "text": "Reports empty branches in a RegExp alternation. An empty branch will only match the empty string, and in most cases that is not what is desired. This inspection will not report a single empty branch at the start or the end of an alternation. Example: '(alpha||bravo)' After the quick-fix is applied: '(alpha|bravo)' New in 2017.2", + "markdown": "Reports empty branches in a RegExp alternation. An empty branch will only match the empty string, and in most cases that is not what is desired. This inspection will not report a single empty branch at the start or the end of an alternation.\n\n**Example:**\n\n\n (alpha||bravo)\n\nAfter the quick-fix is applied:\n\n\n (alpha|bravo)\n\nNew in 2017.2" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpEmptyAlternationBranch", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CheckValidXmlInScriptTagBody", + "shortDescription": { + "text": "Malformed content of 'script' tag" + }, + "fullDescription": { + "text": "Reports contents of 'script' tags that are invalid XML. Example: '' After the quick-fix is applied: ''", + "markdown": "Reports contents of `script` tags that are invalid XML. \n\n**Example:**\n\n\n \n\nAfter the quick-fix is applied:\n\n\n \n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "CheckValidXmlInScriptTagBody", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "Annotator", + "shortDescription": { + "text": "Annotator" + }, + "fullDescription": { + "text": "Reports issues essential to this file (e.g., syntax errors) in the result of a batch code inspection run. These issues are usually always highlighted in the editor and can't be configured, unlike inspections. These options control the scope of checks performed by this inspection: Option \"Report syntax errors\": report parser-related issues. Option \"Report issues from language-specific annotators\": report issues found by annotators configured for the relevant language. See Custom Language Support: Annotators for details. Option \"Report other highlighting problems\": report issues specific to the language of the current file (e.g., type mismatches or unreported exceptions). See Custom Language Support: Highlighting for details.", + "markdown": "Reports issues essential to this file (e.g., syntax errors) in the result of a batch code inspection run. These issues are usually always highlighted in the editor and can't be configured, unlike inspections. These options control the scope of checks performed by this inspection:\n\n* Option \"**Report syntax errors**\": report parser-related issues.\n* Option \"**Report issues from language-specific annotators** \": report issues found by annotators configured for the relevant language. See [Custom Language Support: Annotators](https://plugins.jetbrains.com/docs/intellij/annotator.html) for details.\n* Option \"**Report other highlighting problems** \": report issues specific to the language of the current file (e.g., type mismatches or unreported exceptions). See [Custom Language Support: Highlighting](https://plugins.jetbrains.com/docs/intellij/syntax-highlighting-and-error-highlighting.html#semantic-highlighting) for details." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "Annotator", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpSuspiciousBackref", + "shortDescription": { + "text": "Suspicious back reference" + }, + "fullDescription": { + "text": "Reports back references that will not be resolvable at runtime. This means that the back reference can never match anything. A back reference will not be resolvable when the group is defined after the back reference, or if the group is defined in a different branch of an alternation. Example of a group defined after its back reference: '\\1(abc)' Example of a group and a back reference in different branches: 'a(b)c|(xy)\\1z' New in 2022.1", + "markdown": "Reports back references that will not be resolvable at runtime. This means that the back reference can never match anything. A back reference will not be resolvable when the group is defined after the back reference, or if the group is defined in a different branch of an alternation.\n\n**Example of a group defined after its back reference:**\n\n\n \\1(abc)\n\n**Example of a group and a back reference in different branches:**\n\n\n a(b)c|(xy)\\1z\n\nNew in 2022.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpSuspiciousBackref", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlPathReference", + "shortDescription": { + "text": "Unresolved file reference" + }, + "fullDescription": { + "text": "Reports an unresolved file reference in XML.", + "markdown": "Reports an unresolved file reference in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlPathReference", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpSingleCharAlternation", + "shortDescription": { + "text": "Single character alternation" + }, + "fullDescription": { + "text": "Reports single char alternation in a RegExp. It is simpler to use a character class instead. This may also provide better matching performance. Example: 'a|b|c|d' After the quick-fix is applied: '[abcd]' New in 2017.1", + "markdown": "Reports single char alternation in a RegExp. It is simpler to use a character class instead. This may also provide better matching performance.\n\n**Example:**\n\n\n a|b|c|d\n\nAfter the quick-fix is applied:\n\n\n [abcd]\n\n\nNew in 2017.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpSingleCharAlternation", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpUnnecessaryNonCapturingGroup", + "shortDescription": { + "text": "Unnecessary non-capturing group" + }, + "fullDescription": { + "text": "Reports unnecessary non-capturing groups, which have no influence on the match result. Example: 'Everybody be cool, (?:this) is a robbery!' After the quick-fix is applied: 'Everybody be cool, this is a robbery!' New in 2021.1", + "markdown": "Reports unnecessary non-capturing groups, which have no influence on the match result.\n\n**Example:**\n\n\n Everybody be cool, (?:this) is a robbery!\n\nAfter the quick-fix is applied:\n\n\n Everybody be cool, this is a robbery!\n\nNew in 2021.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpUnnecessaryNonCapturingGroup", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "TodoComment", + "shortDescription": { + "text": "TODO comment" + }, + "fullDescription": { + "text": "Reports TODO comments in your code. You can configure the format for TODO comments in Settings | Editor | TODO. Enable the Only warn on TODO comments without any details option to only warn on empty TODO comments, that don't provide any description on the task that should be done. Disable to report all TODO comments.", + "markdown": "Reports **TODO** comments in your code.\n\nYou can configure the format for **TODO** comments in [Settings \\| Editor \\| TODO](settings://preferences.toDoOptions).\n\nEnable the **Only warn on TODO comments without any details** option to only warn on empty TODO comments, that\ndon't provide any description on the task that should be done. Disable to report all TODO comments." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "TodoComment", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlUnknownAttribute", + "shortDescription": { + "text": "Unknown attribute" + }, + "fullDescription": { + "text": "Reports an unknown HTML attribute. Suggests configuring attributes that should not be reported.", + "markdown": "Reports an unknown HTML attribute. Suggests configuring attributes that should not be reported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlUnknownAttribute", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CheckTagEmptyBody", + "shortDescription": { + "text": "Empty element content" + }, + "fullDescription": { + "text": "Reports XML elements without contents. Example: '\n \n ' After the quick-fix is applied: '\n \n '", + "markdown": "Reports XML elements without contents.\n\n**Example:**\n\n\n \n \n \n\nAfter the quick-fix is applied:\n\n\n \n \n \n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "CheckTagEmptyBody", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpRedundantEscape", + "shortDescription": { + "text": "Redundant character escape" + }, + "fullDescription": { + "text": "Reports redundant character escape sequences that can be replaced with unescaped characters preserving the meaning. Many escape sequences that are necessary outside of a character class are redundant inside square brackets '[]' of a character class. Although unescaped opening curly braces '{' outside of character classes are allowed in some dialects (JavaScript, Python, and so on), it can cause confusion and make the pattern less portable, because there are dialects that require escaping curly braces as characters. For this reason the inspection does not report escaped opening curly braces. Example: '\\-\\;[\\.]' After the quick-fix is applied: '-;[.]' The Ignore escaped closing brackets '}' and ']' option specifies whether to report '\\}' and '\\]' outside of a character class when they are allowed to be unescaped by the RegExp dialect. New in 2017.3", + "markdown": "Reports redundant character escape sequences that can be replaced with unescaped characters preserving the meaning. Many escape sequences that are necessary outside of a character class are redundant inside square brackets `[]` of a character class.\n\n\nAlthough unescaped opening curly braces `{` outside of character classes are allowed in some dialects (JavaScript, Python, and so on),\nit can cause confusion and make the pattern less portable, because there are dialects that require escaping curly braces as characters.\nFor this reason the inspection does not report escaped opening curly braces.\n\n**Example:**\n\n\n \\-\\;[\\.]\n\nAfter the quick-fix is applied:\n\n\n -;[.]\n\n\nThe **Ignore escaped closing brackets '}' and '\\]'** option specifies whether to report `\\}` and `\\]` outside of a character class\nwhen they are allowed to be unescaped by the RegExp dialect.\n\nNew in 2017.3" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpRedundantEscape", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "Json5StandardCompliance", + "shortDescription": { + "text": "Compliance with JSON5 standard" + }, + "fullDescription": { + "text": "Reports inconsistency with the language specification in a JSON5 file.", + "markdown": "Reports inconsistency with [the language specification](http://json5.org) in a JSON5 file." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "Json5StandardCompliance", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "JsonDuplicatePropertyKeys", + "shortDescription": { + "text": "Duplicate keys in object literals" + }, + "fullDescription": { + "text": "Reports a duplicate key in an object literal.", + "markdown": "Reports a duplicate key in an object literal." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "JsonDuplicatePropertyKeys", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "UnresolvedReference", + "shortDescription": { + "text": "Unresolved reference" + }, + "fullDescription": { + "text": "Reports an unresolved reference to a named pattern ('define') in RELAX-NG files that use XML syntax. Suggests creating the referenced 'define' element.", + "markdown": "Reports an unresolved reference to a named pattern (`define`) in RELAX-NG files that use XML syntax. Suggests creating the referenced `define` element." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "UnresolvedReference", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "RELAX NG", + "index": 15, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlMissingClosingTag", + "shortDescription": { + "text": "Missing closing tag" + }, + "fullDescription": { + "text": "Reports an HTML element without a closing tag. Some coding styles require that HTML elements have closing tags even where this is optional. Example: '\n \n

Behold!\n \n ' After the quick-fix is applied: '\n \n

Behold!

\n \n '", + "markdown": "Reports an HTML element without a closing tag. Some coding styles require that HTML elements have closing tags even where this is optional.\n\n**Example:**\n\n\n \n \n

Behold!\n \n \n\nAfter the quick-fix is applied:\n\n\n \n \n

Behold!

\n \n \n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "HtmlMissingClosingTag", + "ideaSeverity": "INFORMATION", + "qodanaSeverity": "Info" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpRedundantNestedCharacterClass", + "shortDescription": { + "text": "Redundant nested character class" + }, + "fullDescription": { + "text": "Reports unnecessary nested character classes. Example: '[a-c[x-z]]' After the quick-fix is applied: '[a-cx-z]' New in 2020.2", + "markdown": "Reports unnecessary nested character classes.\n\n**Example:**\n\n\n [a-c[x-z]]\n\nAfter the quick-fix is applied:\n\n\n [a-cx-z]\n\nNew in 2020.2" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpRedundantNestedCharacterClass", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlDeprecatedElement", + "shortDescription": { + "text": "Deprecated symbol" + }, + "fullDescription": { + "text": "Reports a deprecated XML element or attribute. Symbols can be marked by XML comment or documentation tag with text 'deprecated'.", + "markdown": "Reports a deprecated XML element or attribute.\n\nSymbols can be marked by XML comment or documentation tag with text 'deprecated'." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "XmlDeprecatedElement", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CustomRegExpInspection", + "shortDescription": { + "text": "Custom RegExp inspection" + }, + "fullDescription": { + "text": "Custom Regex Inspection", + "markdown": "Custom Regex Inspection" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "CustomRegExpInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "IncorrectFormatting", + "shortDescription": { + "text": "Incorrect formatting" + }, + "fullDescription": { + "text": "Reports formatting issues that appear if your code doesn't follow your project's code style settings. This inspection is not compatible with languages that require third-party formatters for code formatting, for example, Go or C with CLangFormat enabled.", + "markdown": "Reports formatting issues that appear if your code doesn't\nfollow your project's code style settings.\n\n\nThis inspection is not compatible with languages that require\nthird-party formatters for code formatting, for example, Go or\nC with CLangFormat enabled." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "IncorrectFormatting", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlWrongAttributeValue", + "shortDescription": { + "text": "Wrong attribute value" + }, + "fullDescription": { + "text": "Reports an incorrect HTML attribute value.", + "markdown": "Reports an incorrect HTML attribute value." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlWrongAttributeValue", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlDefaultAttributeValue", + "shortDescription": { + "text": "Redundant attribute with default value" + }, + "fullDescription": { + "text": "Reports a redundant assignment of the default value to an XML attribute.", + "markdown": "Reports a redundant assignment of the default value to an XML attribute." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "XmlDefaultAttributeValue", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlExtraClosingTag", + "shortDescription": { + "text": "Redundant closing tag" + }, + "fullDescription": { + "text": "Reports redundant closing tags on empty elements, for example, 'img' or 'br'. Example: '\n \n

\n \n ' After the quick-fix is applied: '\n \n
\n \n '", + "markdown": "Reports redundant closing tags on empty elements, for example, `img` or `br`.\n\n**Example:**\n\n\n \n \n

\n \n \n\nAfter the quick-fix is applied:\n\n\n \n \n
\n \n \n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlExtraClosingTag", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpOctalEscape", + "shortDescription": { + "text": "Octal escape" + }, + "fullDescription": { + "text": "Reports octal escapes, which are easily confused with back references. Use hexadecimal escapes to avoid confusion. Example: '\\07' After the quick-fix is applied: '\\x07' New in 2017.1", + "markdown": "Reports octal escapes, which are easily confused with back references. Use hexadecimal escapes to avoid confusion.\n\n**Example:**\n\n\n \\07\n\nAfter the quick-fix is applied:\n\n\n \\x07\n\nNew in 2017.1" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "RegExpOctalEscape", + "ideaSeverity": "INFORMATION", + "qodanaSeverity": "Info" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlUnknownAnchorTarget", + "shortDescription": { + "text": "Unresolved fragment in a link" + }, + "fullDescription": { + "text": "Reports an unresolved last part of an URL after the '#' sign.", + "markdown": "Reports an unresolved last part of an URL after the `#` sign." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlUnknownAnchorTarget", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "UnusedDefine", + "shortDescription": { + "text": "Unused define" + }, + "fullDescription": { + "text": "Reports an unused named pattern ('define') in a RELAX-NG file (XML or Compact Syntax). 'define' elements that are used through an include in another file are ignored.", + "markdown": "Reports an unused named pattern (`define`) in a RELAX-NG file (XML or Compact Syntax). `define` elements that are used through an include in another file are ignored." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "UnusedDefine", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RELAX NG", + "index": 15, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "JsonSchemaCompliance", + "shortDescription": { + "text": "Compliance with JSON schema" + }, + "fullDescription": { + "text": "Reports inconsistence between a JSON file and the JSON schema that is assigned to it.", + "markdown": "Reports inconsistence between a JSON file and the [JSON schema](https://json-schema.org) that is assigned to it. " + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "JsonSchemaCompliance", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpUnexpectedAnchor", + "shortDescription": { + "text": "Begin or end anchor in unexpected position" + }, + "fullDescription": { + "text": "Reports '^' or '\\A' anchors not at the beginning of the pattern and '$', '\\Z' or '\\z' anchors not at the end of the pattern. In the wrong position these RegExp anchors prevent the pattern from matching anything. In case of the '^' and '$' anchors, most likely the literal character was meant and the escape forgotten. Example: '(Price $10)' New in 2018.1", + "markdown": "Reports `^` or `\\A` anchors not at the beginning of the pattern and `$`, `\\Z` or `\\z` anchors not at the end of the pattern. In the wrong position these RegExp anchors prevent the pattern from matching anything. In case of the `^` and `$` anchors, most likely the literal character was meant and the escape forgotten.\n\n**Example:**\n\n\n (Price $10)\n\n\nNew in 2018.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpUnexpectedAnchor", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "EmptyDirectory", + "shortDescription": { + "text": "Empty directory" + }, + "fullDescription": { + "text": "Reports empty directories. Available only from Code | Inspect Code or Code | Analyze Code | Run Inspection by Name and isn't reported in the editor. Use the Only report empty directories located under a source folder option to have only directories under source roots reported.", + "markdown": "Reports empty directories.\n\nAvailable only from **Code \\| Inspect Code** or\n**Code \\| Analyze Code \\| Run Inspection by Name** and isn't reported in the editor.\n\nUse the **Only report empty directories located under a source folder** option to have only directories under source\nroots reported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "EmptyDirectory", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpAnonymousGroup", + "shortDescription": { + "text": "Anonymous capturing group or numeric back reference" + }, + "fullDescription": { + "text": "Reports anonymous capturing groups and numeric back references in a RegExp. These are only reported when the RegExp dialect supports named group and named group references. Named groups and named back references improve code readability and are recommended to use instead. When a capture is not needed, matching can be more performant and use less memory by using a non-capturing group, i.e. '(?:xxx)' instead of '(xxx)'. Example: '(\\d\\d\\d\\d)\\1' A better regex pattern could look like this: '(?\\d\\d\\d\\d)\\k' New in 2017.2", + "markdown": "Reports anonymous capturing groups and numeric back references in a RegExp. These are only reported when the RegExp dialect supports named group and named group references. Named groups and named back references improve code readability and are recommended to use instead. When a capture is not needed, matching can be more performant and use less memory by using a non-capturing group, i.e. `(?:xxx)` instead of `(xxx)`.\n\n**Example:**\n\n\n (\\d\\d\\d\\d)\\1\n\nA better regex pattern could look like this:\n\n\n (?\\d\\d\\d\\d)\\k\n\nNew in 2017.2" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpAnonymousGroup", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CheckDtdRefs", + "shortDescription": { + "text": "Unresolved DTD reference" + }, + "fullDescription": { + "text": "Reports inconsistency in a DTD-specific reference, for example, in a reference to an XML entity or to a DTD element declaration. Works in DTD an XML files.", + "markdown": "Reports inconsistency in a DTD-specific reference, for example, in a reference to an XML entity or to a DTD element declaration. Works in DTD an XML files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "CheckDtdRefs", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "SpellCheckingInspection", + "shortDescription": { + "text": "Typo" + }, + "fullDescription": { + "text": "Reports typos and misspellings in your code, comments, and literals and fixes them with one click.", + "markdown": "Reports typos and misspellings in your code, comments, and literals and fixes them with one click." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "SpellCheckingInspection", + "ideaSeverity": "TYPO", + "qodanaSeverity": "Low" + } + }, + "relationships": [ + { + "target": { + "id": "Proofreading", + "index": 16, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CheckXmlFileWithXercesValidator", + "shortDescription": { + "text": "Failed external validation" + }, + "fullDescription": { + "text": "Reports a discrepancy in an XML file with the specified DTD or schema detected by the Xerces validator.", + "markdown": "Reports a discrepancy in an XML file with the specified DTD or schema detected by the Xerces validator." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "CheckXmlFileWithXercesValidator", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "NonAsciiCharacters", + "shortDescription": { + "text": "Non-ASCII characters" + }, + "fullDescription": { + "text": "Reports code elements that use non-ASCII symbols in an unusual context. Example: Non-ASCII characters used in identifiers, strings, or comments. Identifiers written in different languages, such as 'myСollection' with the letter 'C' written in Cyrillic. Comments or strings containing Unicode symbols, such as long dashes and arrows.", + "markdown": "Reports code elements that use non-ASCII symbols in an unusual context.\n\nExample:\n\n* Non-ASCII characters used in identifiers, strings, or comments.\n* Identifiers written in different languages, such as `my`**С**`ollection` with the letter **C** written in Cyrillic.\n* Comments or strings containing Unicode symbols, such as long dashes and arrows." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "NonAsciiCharacters", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Internationalization", + "index": 17, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "XmlUnresolvedReference", + "shortDescription": { + "text": "Unresolved references" + }, + "fullDescription": { + "text": "Reports an unresolved references in XML.", + "markdown": "Reports an unresolved references in XML." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "XmlUnresolvedReference", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "XML", + "index": 3, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "HtmlUnknownTag", + "shortDescription": { + "text": "Unknown tag" + }, + "fullDescription": { + "text": "Reports an unknown HTML tag. Suggests configuring tags that should not be reported.", + "markdown": "Reports an unknown HTML tag. Suggests configuring tags that should not be reported." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "HtmlUnknownTag", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "LossyEncoding", + "shortDescription": { + "text": "Lossy encoding" + }, + "fullDescription": { + "text": "Reports characters that cannot be displayed because of the current document encoding. Examples: If you type international characters in a document with the US-ASCII charset, some characters will be lost on save. If you load a UTF-8-encoded file using the ISO-8859-1 one-byte charset, some characters will be displayed incorrectly. You can fix this by changing the file encoding either by specifying the encoding directly in the file, e.g. by editing 'encoding=' attribute in the XML prolog of XML file, or by changing the corresponding options in Settings | Editor | File Encodings.", + "markdown": "Reports characters that cannot be displayed because of the current document encoding.\n\nExamples:\n\n* If you type international characters in a document with the **US-ASCII** charset, some characters will be lost on save.\n* If you load a **UTF-8** -encoded file using the **ISO-8859-1** one-byte charset, some characters will be displayed incorrectly.\n\nYou can fix this by changing the file encoding\neither by specifying the encoding directly in the file, e.g. by editing `encoding=` attribute in the XML prolog of XML file,\nor by changing the corresponding options in **Settings \\| Editor \\| File Encodings**." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "LossyEncoding", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Internationalization", + "index": 17, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpEscapedMetaCharacter", + "shortDescription": { + "text": "Escaped meta character" + }, + "fullDescription": { + "text": "Reports escaped meta characters. Some RegExp coding styles specify that meta characters should be placed inside a character class, to make the regular expression easier to understand. This inspection does not warn about the meta character '[', ']' and '^', because those would need additional escaping inside a character class. Example: '\\d+\\.\\d+' After the quick-fix is applied: '\\d+[.]\\d+' New in 2017.1", + "markdown": "Reports escaped meta characters. Some RegExp coding styles specify that meta characters should be placed inside a character class, to make the regular expression easier to understand. This inspection does not warn about the meta character `[`, `]` and `^`, because those would need additional escaping inside a character class.\n\n**Example:**\n\n\n \\d+\\.\\d+\n\nAfter the quick-fix is applied:\n\n\n \\d+[.]\\d+\n\nNew in 2017.1" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "RegExpEscapedMetaCharacter", + "ideaSeverity": "INFORMATION", + "qodanaSeverity": "Info" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpDuplicateAlternationBranch", + "shortDescription": { + "text": "Duplicate branch in alternation" + }, + "fullDescription": { + "text": "Reports duplicate branches in a RegExp alternation. Duplicate branches slow down matching and obscure the intent of the expression. Example: '(alpha|bravo|charlie|alpha)' After the quick-fix is applied: '(alpha|bravo|charlie)' New in 2017.1", + "markdown": "Reports duplicate branches in a RegExp alternation. Duplicate branches slow down matching and obscure the intent of the expression.\n\n**Example:**\n\n\n (alpha|bravo|charlie|alpha)\n\nAfter the quick-fix is applied:\n\n\n (alpha|bravo|charlie)\n\nNew in 2017.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpDuplicateAlternationBranch", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "RegExpRepeatedSpace", + "shortDescription": { + "text": "Consecutive spaces" + }, + "fullDescription": { + "text": "Reports multiple consecutive spaces in a RegExp. Because spaces are not visible by default, it can be hard to see how many spaces are required. The RegExp can be made more clear by replacing the consecutive spaces with a single space and a counted quantifier. Example: '( )' After the quick-fix is applied: '( {5})' New in 2017.1", + "markdown": "Reports multiple consecutive spaces in a RegExp. Because spaces are not visible by default, it can be hard to see how many spaces are required. The RegExp can be made more clear by replacing the consecutive spaces with a single space and a counted quantifier.\n\n**Example:**\n\n\n ( )\n\nAfter the quick-fix is applied:\n\n\n ( {5})\n\n\nNew in 2017.1" + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "RegExpRepeatedSpace", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "RegExp", + "index": 6, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "IgnoreFileDuplicateEntry", + "shortDescription": { + "text": "Ignore file duplicates" + }, + "fullDescription": { + "text": "Reports duplicate entries (patterns) in the ignore file (e.g. .gitignore, .hgignore). Duplicate entries in these files are redundant and can be removed. Example: '# Output directories\n /out/\n /target/\n /out/'", + "markdown": "Reports duplicate entries (patterns) in the ignore file (e.g. .gitignore, .hgignore). Duplicate entries in these files are redundant and can be removed.\n\nExample:\n\n\n # Output directories\n /out/\n /target/\n /out/\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "IgnoreFileDuplicateEntry", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Version control", + "index": 20, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "JsonStandardCompliance", + "shortDescription": { + "text": "Compliance with JSON standard" + }, + "fullDescription": { + "text": "Reports the following discrepancies of a JSON file with the language specification: A line or block comment (configurable). Multiple top-level values (expect for JSON Lines files, configurable for others). A trailing comma in an object or array (configurable). A single quoted string. A property key is a not a double quoted strings. A NaN or Infinity/-Infinity numeric value as a floating point literal (configurable).", + "markdown": "Reports the following discrepancies of a JSON file with [the language specification](https://tools.ietf.org/html/rfc7159):\n\n* A line or block comment (configurable).\n* Multiple top-level values (expect for JSON Lines files, configurable for others).\n* A trailing comma in an object or array (configurable).\n* A single quoted string.\n* A property key is a not a double quoted strings.\n* A NaN or Infinity/-Infinity numeric value as a floating point literal (configurable)." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "JsonStandardCompliance", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "JSON and JSON5", + "index": 5, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "CheckEmptyScriptTag", + "shortDescription": { + "text": "Empty tag" + }, + "fullDescription": { + "text": "Reports empty tags that do not work in some browsers. Example: '\n \n '", + "markdown": "Reports empty tags that do not work in some browsers.\n\n**Example:**\n\n\n \n \n \n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "CheckEmptyScriptTag", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "HTML", + "index": 9, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.jetbrains.plugins.yaml", + "version": "241.17890.14", + "rules": [ + { + "id": "YAMLRecursiveAlias", + "shortDescription": { + "text": "Recursive alias" + }, + "fullDescription": { + "text": "Reports recursion in YAML aliases. Alias can't be recursive and be used inside the data referenced by a corresponding anchor. Example: 'some_key: &some_anchor\n sub_key1: value1\n sub_key2: *some_anchor'", + "markdown": "Reports recursion in YAML aliases.\n\nAlias can't be recursive and be used inside the data referenced by a corresponding anchor.\n\n**Example:**\n\n\n some_key: &some_anchor\n sub_key1: value1\n sub_key2: *some_anchor\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "YAMLRecursiveAlias", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLSchemaValidation", + "shortDescription": { + "text": "Validation by JSON Schema" + }, + "fullDescription": { + "text": "Reports inconsistencies between a YAML file and a JSON Schema if the schema is specified. Scheme example: '{\n \"properties\": {\n \"SomeNumberProperty\": {\n \"type\": \"number\"\n }\n }\n }' The following is an example with the corresponding warning: 'SomeNumberProperty: hello world'", + "markdown": "Reports inconsistencies between a YAML file and a JSON Schema if the schema is specified.\n\n**Scheme example:**\n\n\n {\n \"properties\": {\n \"SomeNumberProperty\": {\n \"type\": \"number\"\n }\n }\n }\n\n**The following is an example with the corresponding warning:**\n\n\n SomeNumberProperty: hello world\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "YAMLSchemaValidation", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLIncompatibleTypes", + "shortDescription": { + "text": "Suspicious type mismatch" + }, + "fullDescription": { + "text": "Reports a mismatch between a scalar value type in YAML file and types of the values in the similar positions. Example: 'myElements:\n - value1\n - value2\n - false # <- reported, because it is a boolean value, while other values are strings'", + "markdown": "Reports a mismatch between a scalar value type in YAML file and types of the values in the similar positions.\n\n**Example:**\n\n\n myElements:\n - value1\n - value2\n - false # <- reported, because it is a boolean value, while other values are strings\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "YAMLIncompatibleTypes", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLDuplicatedKeys", + "shortDescription": { + "text": "Duplicated YAML keys" + }, + "fullDescription": { + "text": "Reports duplicated keys in YAML files. Example: 'same_key: some value\n same_key: another value'", + "markdown": "Reports duplicated keys in YAML files.\n\n**Example:**\n\n\n same_key: some value\n same_key: another value\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "YAMLDuplicatedKeys", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLUnusedAnchor", + "shortDescription": { + "text": "Unused anchor" + }, + "fullDescription": { + "text": "Reports unused anchors. Example: 'some_key: &some_anchor\n key1: value1'", + "markdown": "Reports unused anchors.\n\n**Example:**\n\n\n some_key: &some_anchor\n key1: value1\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "YAMLUnusedAnchor", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLUnresolvedAlias", + "shortDescription": { + "text": "Unresolved alias" + }, + "fullDescription": { + "text": "Reports unresolved aliases in YAML files. Example: 'some_key: *unknown_alias'", + "markdown": "Reports unresolved aliases in YAML files.\n\n**Example:**\n\n\n some_key: *unknown_alias\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "YAMLUnresolvedAlias", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "YAMLSchemaDeprecation", + "shortDescription": { + "text": "Deprecated YAML key" + }, + "fullDescription": { + "text": "Reports deprecated keys in YAML files. Deprecation is checked only if there exists a JSON schema associated with the corresponding YAML file. Note that the deprecation mechanism is not defined in the JSON Schema specification yet, and this inspection uses a non-standard 'deprecationMessage' extension. Scheme deprecation example: '{\n \"properties\": {\n \"SomeDeprecatedProperty\": {\n \"deprecationMessage\": \"Baz\",\n \"description\": \"Foo bar\"\n }\n }\n }' The following is an example with the corresponding warning: 'SomeDeprecatedProperty: some value'", + "markdown": "Reports deprecated keys in YAML files.\n\nDeprecation is checked only if there exists a JSON schema associated with the corresponding YAML file.\n\nNote that the deprecation mechanism is not defined in the JSON Schema specification yet,\nand this inspection uses a non-standard `deprecationMessage` extension.\n\n**Scheme deprecation example:**\n\n\n {\n \"properties\": {\n \"SomeDeprecatedProperty\": {\n \"deprecationMessage\": \"Baz\",\n \"description\": \"Foo bar\"\n }\n }\n }\n\n**The following is an example with the corresponding warning:**\n\n\n SomeDeprecatedProperty: some value\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "YAMLSchemaDeprecation", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "YAML", + "index": 4, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "com.intellij.properties", + "version": "241.17890.14", + "rules": [ + { + "id": "DuplicatePropertyInspection", + "shortDescription": { + "text": "Duplicate property" + }, + "fullDescription": { + "text": "Reports duplicate property keys with different values, duplicate keys, or duplicate property values. Example: 'property1=value;\nproperty2=value;' The Options list allows selecting the area in which the inspection should search for duplicates.", + "markdown": "Reports duplicate property keys with different values, duplicate keys, or duplicate property values.\n\nExample:\n\n\n property1=value;\n property2=value;\n\nThe **Options** list allows selecting the area in which the inspection should search for duplicates." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "DuplicatePropertyInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "UseEllipsisInPropertyInspection", + "shortDescription": { + "text": "Three dot characters instead of the ellipsis" + }, + "fullDescription": { + "text": "Reports three \"dot\" characters which are used instead of the ellipsis character for UTF-8 properties files.", + "markdown": "Reports three \"dot\" characters which are used instead of the ellipsis character for UTF-8 properties files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "UseEllipsisInPropertyInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "AlphaUnsortedPropertiesFile", + "shortDescription": { + "text": "Properties file or resource bundle is alphabetically unsorted" + }, + "fullDescription": { + "text": "Reports alphabetically unsorted resource bundles or .properties files.", + "markdown": "Reports alphabetically unsorted resource bundles or .properties files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "AlphaUnsortedPropertiesFile", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "TrailingSpacesInProperty", + "shortDescription": { + "text": "Trailing spaces in property" + }, + "fullDescription": { + "text": "Reports properties whose keys or values end with a whitespace.", + "markdown": "Reports properties whose keys or values end with a whitespace." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "TrailingSpacesInProperty", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "UnusedProperty", + "shortDescription": { + "text": "Unused property" + }, + "fullDescription": { + "text": "Reports properties that are not referenced outside of the .properties file they are contained in.", + "markdown": "Reports properties that are not referenced outside of the .properties file they are contained in." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "UnusedProperty", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "WrongPropertyKeyValueDelimiter", + "shortDescription": { + "text": "Property key/value delimiter doesn't match code style settings" + }, + "fullDescription": { + "text": "Reports properties in which key or value delimiters do not match code style settings.", + "markdown": "Reports properties in which key or value delimiters do not match code style settings." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "WrongPropertyKeyValueDelimiter", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Properties files", + "index": 7, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.intellij.plugins.markdown", + "version": "241.17890.14", + "rules": [ + { + "id": "MarkdownOutdatedTableOfContents", + "shortDescription": { + "text": "Outdated table of contents section" + }, + "fullDescription": { + "text": "Checks if a particular table of contents section corresponds to the actual structure of the document.", + "markdown": "Checks if a particular table of contents section corresponds to the actual structure of the document." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownOutdatedTableOfContents", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownNoTableBorders", + "shortDescription": { + "text": "Table doesn't have side borders" + }, + "fullDescription": { + "text": "Checks if table has correct side borders. For compatibility reasons all table rows should have borders (pipe symbols) at the start and at the end.", + "markdown": "Checks if table has correct side borders. For compatibility reasons all table rows should have borders (pipe symbols) at the start and at the end." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownNoTableBorders", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownUnresolvedLinkLabel", + "shortDescription": { + "text": "Unresolved link label" + }, + "fullDescription": { + "text": "Reports unresolved link labels in Markdown files.", + "markdown": "Reports unresolved link labels in Markdown files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownUnresolvedLinkLabel", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownUnresolvedFileReference", + "shortDescription": { + "text": "Unresolved file references" + }, + "fullDescription": { + "text": "Reports unresolved file references in Markdown files.", + "markdown": "Reports unresolved file references in Markdown files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownUnresolvedFileReference", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownIncorrectTableFormatting", + "shortDescription": { + "text": "Incorrect table formatting" + }, + "fullDescription": { + "text": "Checks if table is correctly formatted.", + "markdown": "Checks if table is correctly formatted." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "MarkdownIncorrectTableFormatting", + "ideaSeverity": "WEAK WARNING", + "qodanaSeverity": "Moderate" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownIncorrectlyNumberedListItem", + "shortDescription": { + "text": "Incorrectly numbered list item" + }, + "fullDescription": { + "text": "Ordered list items are expected to have straight numeration starting from 1. The motivation behind this is that most of Markdown processors are ignoring the numbering of ordered lists. A processor will generate an '
    ' element for such list, that will number items continuously from 1.", + "markdown": "Ordered list items are expected to have straight numeration starting from 1.\n\nThe motivation behind this is that most of Markdown processors are ignoring the numbering of ordered lists. A processor will generate an `
      ` element for such list, that will number items continuously from 1." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownIncorrectlyNumberedListItem", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownLinkDestinationWithSpaces", + "shortDescription": { + "text": "Links should not contain spaces" + }, + "fullDescription": { + "text": "To ensure consistency between different tools, file links should not contain spaces. Example: '[Some file link](some file.md)' A quick-fix replaces spaces with their url-encoded equivalent: '[Some file link](some%20file.md)'", + "markdown": "To ensure consistency between different tools, file links should not contain spaces.\n\n**Example:**\n\n\n [Some file link](some file.md)\n\nA quick-fix replaces spaces with their url-encoded equivalent:\n\n\n [Some file link](some%20file.md)\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownLinkDestinationWithSpaces", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "MarkdownUnresolvedHeaderReference", + "shortDescription": { + "text": "Unresolved header reference" + }, + "fullDescription": { + "text": "Reports unresolved header references in Markdown files.", + "markdown": "Reports unresolved header references in Markdown files." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "MarkdownUnresolvedHeaderReference", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Markdown", + "index": 8, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.intellij.qodana", + "version": "241.17890.14", + "rules": [ + { + "id": "QodanaSanity", + "shortDescription": { + "text": "Sanity" + }, + "fullDescription": { + "text": "Reports issues essential to this file like syntax errors, unresolved methods and variables, etc...", + "markdown": "Reports issues essential to this file like syntax errors, unresolved methods and variables, etc..." + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "QodanaSanity", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "Qodana", + "index": 13, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.intellij.intelliLang", + "version": "241.17890.14", + "rules": [ + { + "id": "InjectedReferences", + "shortDescription": { + "text": "Injected references" + }, + "fullDescription": { + "text": "Reports unresolved references injected by Language Injections. Example: '@Language(\"file-reference\")\n String fileName = \"/home/user/nonexistent.file\"; // highlighted if file doesn't exist'", + "markdown": "Reports unresolved references injected by [Language Injections](https://www.jetbrains.com/help/idea/using-language-injections.html).\n\nExample:\n\n\n @Language(\"file-reference\")\n String fileName = \"/home/user/nonexistent.file\"; // highlighted if file doesn't exist\n" + }, + "defaultConfiguration": { + "enabled": false, + "level": "error", + "parameters": { + "suppressToolId": "InjectedReferences", + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + "relationships": [ + { + "target": { + "id": "General", + "index": 10, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.jetbrains.security.package-checker", + "version": "241.17890.14", + "rules": [ + { + "id": "PyVulnerableApiCodeInspection", + "shortDescription": { + "text": "Vulnerable API usage" + }, + "fullDescription": { + "text": "Reports usages of Vulnerable APIs of imported dependencies. Fixing the reported problems helps prevent your software from being compromised by an attacker. To solve a problem, you can update to a version where the vulnerability is fixed (if available) or switch to a dependency that doesn't have the vulnerability. Vulnerability data provided by Checkmarx (c).", + "markdown": "Reports usages of Vulnerable APIs of imported dependencies.\n\nFixing the reported problems helps prevent your software from being compromised by an attacker.\n\nTo solve a problem, you can update to a version where the vulnerability is fixed (if available) or switch to a dependency that doesn't have the vulnerability.\n\nVulnerability data provided by [Checkmarx](https://checkmarx.com/) (c)." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "PyVulnerableApiCode", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Python/Security", + "index": 14, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "VulnerableLibrariesLocal", + "shortDescription": { + "text": "Vulnerable declared dependency" + }, + "fullDescription": { + "text": "Reports vulnerabilities in Gradle, Maven, NPM and PyPI dependencies declared in your project. A full list of Gradle and Maven dependencies is shown in the Project tool window under External Libraries. Fixing the reported problems helps prevent your software from being compromised by an attacker. To solve a problem, you can update to a version where the vulnerability is fixed (if available) or switch to a dependency that doesn't have the vulnerability. The quick-fixes available may suggest updating to a safe version or visiting the Checkmarx website to learn more about a particular vulnerability. Vulnerability data provided by Checkmarx (c).", + "markdown": "Reports vulnerabilities in Gradle, Maven, NPM and PyPI dependencies declared in your project.\nA full list of Gradle and Maven dependencies is shown in the Project tool window under External Libraries.\n\nFixing the reported problems helps prevent your software from being compromised by an attacker.\n\nTo solve a problem, you can update to a version where the vulnerability is fixed (if available) or switch to a dependency that doesn't have the vulnerability.\n\nThe quick-fixes available may suggest updating to a safe version or visiting the Checkmarx website to learn more about a particular vulnerability.\n\nVulnerability data provided by [Checkmarx](https://checkmarx.com/) (c)." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "VulnerableLibrariesLocal", + "cweIds": [ + 1395 + ], + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Security", + "index": 19, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "tanvd.grazi", + "version": "241.17890.14", + "rules": [ + { + "id": "LanguageDetectionInspection", + "shortDescription": { + "text": "Natural language detection" + }, + "fullDescription": { + "text": "Detects natural languages and suggests enabling corresponding grammar and spelling checks.", + "markdown": "Detects natural languages and suggests enabling corresponding grammar and spelling checks." + }, + "defaultConfiguration": { + "enabled": false, + "level": "warning", + "parameters": { + "suppressToolId": "LanguageDetectionInspection", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "Proofreading", + "index": 16, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + }, + { + "id": "GrazieInspection", + "shortDescription": { + "text": "Grammar" + }, + "fullDescription": { + "text": "Reports grammar mistakes in your text. You can configure the inspection in Settings | Editor | Natural Languages | Grammar.", + "markdown": "Reports grammar mistakes in your text. You can configure the inspection in [Settings \\| Editor \\| Natural Languages \\| Grammar](settings://reference.settingsdialog.project.grazie)." + }, + "defaultConfiguration": { + "enabled": false, + "level": "note", + "parameters": { + "suppressToolId": "GrazieInspection", + "ideaSeverity": "GRAMMAR_ERROR", + "qodanaSeverity": "Info" + } + }, + "relationships": [ + { + "target": { + "id": "Proofreading", + "index": 16, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + }, + { + "name": "org.toml.lang", + "version": "241.17890.14", + "rules": [ + { + "id": "TomlUnresolvedReference", + "shortDescription": { + "text": "Unresolved reference" + }, + "fullDescription": { + "text": "Reports unresolved references in TOML files.", + "markdown": "Reports unresolved references in TOML files." + }, + "defaultConfiguration": { + "enabled": true, + "level": "warning", + "parameters": { + "suppressToolId": "TomlUnresolvedReference", + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + "relationships": [ + { + "target": { + "id": "TOML", + "index": 18, + "toolComponent": { + "name": "PC" + } + }, + "kinds": [ + "superset" + ] + } + ] + } + ], + "language": "en-US", + "contents": [ + "localizedData", + "nonLocalizedData" + ], + "isComprehensive": false + } + ] + }, + "invocations": [ + { + "startTimeUtc": "2024-06-14T21:42:58.2125862Z", + "exitCode": 0, + "executionSuccessful": true + } + ], + "language": "en-US", + "versionControlProvenance": [ + { + "repositoryUri": "https://github.com/Franck1333/FR_Template.git", + "revisionId": "2ae8fcbcbab47ae82526cf73d1deb85594385323", + "branch": "master", + "properties": { + "repoUrl": "https://github.com/Franck1333/FR_Template.git", + "lastAuthorName": "Franck Rochat", + "vcsType": "Git", + "lastAuthorEmail": "fun13@live.fr" + } + } + ], + "results": [], + "automationDetails": { + "id": "README.md/qodana/2024-06-14", + "guid": "7458125b-153c-4eee-ad14-824cfbc20b33", + "properties": { + "jobUrl": "" + } + }, + "newlineSequences": [ + "\r\n", + "\n" + ], + "properties": { + "qodana.sanity.results": [ + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import time'", + "markdown": "Unused import statement `import time`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/nettoyage_du_cache.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 9, + "startColumn": 1, + "charOffset": 214, + "charLength": 11, + "snippet": { + "text": "import time" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 7, + "startColumn": 1, + "charOffset": 197, + "charLength": 52, + "snippet": { + "text": "\r\nimport serial\r\nimport time\r\nimport os\r\nimport sys\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "9e184d77efe18600", + "equalIndicator/v1": "1e1c272fd15ec8ffe935d3070962d93f434edf3f8b20be273ef16a363135cf75" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import sys #Blibliotheque permettant l'interaction ...'", + "markdown": "Unused import statement `import sys #Blibliotheque permettant l'interaction ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 6, + "startColumn": 1, + "charOffset": 276, + "charLength": 115, + "snippet": { + "text": "import sys #Blibliotheque permettant l'interaction avec le systeme" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 4, + "startColumn": 1, + "charOffset": 64, + "charLength": 538, + "snippet": { + "text": "#---------------------------------------Importante LIB---------------------------------------\r\nimport os #Blibliotheque permettant l'interaction avec le systeme\r\nimport sys #Blibliotheque permettant l'interaction avec le systeme\r\nimport datetime #Blibliotheque permettant d'obtenir la date\r\nimport time #Blibliotheque permettant d'obtenir la date\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "0a988ed8a197d6db", + "equalIndicator/v1": "23a52fb26b0ebe56cfcdf8235fbbf1bde9bc5c670ff1c9112a94872af31a8f12" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import os #Blibliotheque permettant l'interaction ...'", + "markdown": "Unused import statement `import os #Blibliotheque permettant l'interaction ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 5, + "startColumn": 1, + "charOffset": 159, + "charLength": 115, + "snippet": { + "text": "import os #Blibliotheque permettant l'interaction avec le systeme" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 3, + "startColumn": 1, + "charOffset": 48, + "charLength": 449, + "snippet": { + "text": "#ROCHAT_FRANCK\r\n#---------------------------------------Importante LIB---------------------------------------\r\nimport os #Blibliotheque permettant l'interaction avec le systeme\r\nimport sys #Blibliotheque permettant l'interaction avec le systeme\r\nimport datetime #Blibliotheque permettant d'obtenir la date\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "262a942cd254e287", + "equalIndicator/v1": "24b29a8c84131546f2f5e231fc4d4e5a0ab5896e8d37f775aa235403815f73b7" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les ...'", + "markdown": "Unused import statement `from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 15, + "startColumn": 1, + "charOffset": 936, + "charLength": 127, + "snippet": { + "text": "from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 13, + "startColumn": 1, + "charOffset": 822, + "charLength": 370, + "snippet": { + "text": "\r\nfrom tkinter import * #Blibliotheque permettant d'obtenir Tkinter(G.U.I)\r\nfrom tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)\r\nimport tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)\r\n\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "d5272a3ada969518", + "equalIndicator/v1": "308f815f77a240bd0273014488835d67b17e60316b527568049bce15518aa480" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'Infos_Hardware'", + "markdown": "Unresolved reference 'Infos_Hardware'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Kivy/Interface_Kivy.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 29, + "startColumn": 6, + "charOffset": 2368, + "charLength": 14, + "snippet": { + "text": "Infos_Hardware" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 27, + "startColumn": 1, + "charOffset": 2203, + "charLength": 519, + "snippet": { + "text": "\r\nfrom Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour\r\nfrom Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere\r\nfrom Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU\r\nfrom Infos_Hardware import MEM_info #Obtention de l'utilisation de la Memoire Vive du Systeme\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "d86717802d9e58dd", + "equalIndicator/v1": "330e275e993479fa1a733aa70fc4b51f2f2b69b86ec6a00674ba4743b816e8b9" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import tkinter.ttk #Blibliotheque permettant de charger un ...'", + "markdown": "Unused import statement `import tkinter.ttk #Blibliotheque permettant de charger un ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 16, + "startColumn": 1, + "charOffset": 1065, + "charLength": 124, + "snippet": { + "text": "import tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 14, + "startColumn": 1, + "charOffset": 824, + "charLength": 483, + "snippet": { + "text": "from tkinter import * #Blibliotheque permettant d'obtenir Tkinter(G.U.I)\r\nfrom tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)\r\nimport tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)\r\n\r\n#from pydub import AudioSegment #Bibliotheque permettant de jouer des Sons et Jingles\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "77bdd5b4269f2e4c", + "equalIndicator/v1": "3a0bbba07de8107ec9bba241975829969285bc265810e70ea7b7567b35328002" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les ...'", + "markdown": "Unused import statement `from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 12, + "startColumn": 1, + "charOffset": 754, + "charLength": 127, + "snippet": { + "text": "from tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 10, + "startColumn": 1, + "charOffset": 618, + "charLength": 392, + "snippet": { + "text": "from tkinter import * #Blibliotheque permettant d'obtenir Tkinter(G.U.I)\r\nfrom tkinter import Tk\r\nfrom tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)\r\nimport tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)\r\n\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "a0c96cc8bd5ca2d7", + "equalIndicator/v1": "51c52f8ce49b9ff8a73cdd3f80ba4913518c4feda5a971e0085392251313ffdb" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import sys'", + "markdown": "Unused import statement `import sys`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/Infos_Hardware.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 13, + "startColumn": 1, + "charOffset": 386, + "charLength": 10, + "snippet": { + "text": "import sys" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 11, + "startColumn": 1, + "charOffset": 373, + "charLength": 54, + "snippet": { + "text": "\r\nimport os\r\nimport sys\r\nimport datetime\r\nimport time\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "780796b78ed957cf", + "equalIndicator/v1": "569b25ed1874c018803c504dd09ab802a935e0c04d7cd39239ccfabb0f2e62b2" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import os #Blibliotheque permettant l'interaction ...'", + "markdown": "Unused import statement `import os #Blibliotheque permettant l'interaction ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 5, + "startColumn": 1, + "charOffset": 159, + "charLength": 115, + "snippet": { + "text": "import os #Blibliotheque permettant l'interaction avec le systeme" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 3, + "startColumn": 1, + "charOffset": 48, + "charLength": 449, + "snippet": { + "text": "#ROCHAT_FRANCK\r\n#---------------------------------------Importante LIB---------------------------------------\r\nimport os #Blibliotheque permettant l'interaction avec le systeme\r\nimport sys #Blibliotheque permettant l'interaction avec le systeme\r\nimport datetime #Blibliotheque permettant d'obtenir la date\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "b497c1acf0531b77", + "equalIndicator/v1": "594f459cef5a46e597acfeca2b5e39a1bc578207e2f4415d6a4199e13fa04d07" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import sys'", + "markdown": "Unused import statement `import sys`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/nettoyage_du_cache.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 11, + "startColumn": 1, + "charOffset": 238, + "charLength": 10, + "snippet": { + "text": "import sys" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 9, + "startColumn": 1, + "charOffset": 214, + "charLength": 86, + "snippet": { + "text": "import time\r\nimport os\r\nimport sys\r\n\r\n#Supprime les fichiers CACHE du language PYTHON\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "dacad678127cdc12", + "equalIndicator/v1": "5c69274bcd5115b03fb1b0702079e3878ee0726216d7816a2b8de3243d9884cd" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'setup'", + "markdown": "Unresolved reference 'setup'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "setup.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 9, + "startColumn": 24, + "charOffset": 220, + "charLength": 5, + "snippet": { + "text": "setup" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 7, + "startColumn": 1, + "charOffset": 136, + "charLength": 115, + "snippet": { + "text": "#And all the depencies will be installed with the Project\r\n\r\nfrom setuptools import setup, find_packages\r\n\r\nsetup(\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "f48cc74dfff73c8b", + "equalIndicator/v1": "64ea29fe0cecea5be89475e89024280724e3ff9e3ac3d0f451b2a34cc7980815" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import tkinter.ttk #Blibliotheque permettant de charger un ...'", + "markdown": "Unused import statement `import tkinter.ttk #Blibliotheque permettant de charger un ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/WINDOWS/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 13, + "startColumn": 1, + "charOffset": 883, + "charLength": 124, + "snippet": { + "text": "import tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 11, + "startColumn": 1, + "charOffset": 730, + "charLength": 395, + "snippet": { + "text": "from tkinter import Tk\r\nfrom tkinter.messagebox import * #Blibliotheque permettant d'obtenir les boites de dialogues (G.U.I)\r\nimport tkinter.ttk #Blibliotheque permettant de charger un composant Tkinter(G.U.I)\r\n\r\n#from pydub import AudioSegment #Bibliotheque permettant de jouer des Sons et Jingles\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "a74ce16511adfab2", + "equalIndicator/v1": "7b34cf476e15bb2cdc6819f1b1615aa2d6b8fec665abc3072dd95fd5acc4af06" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'Infos_Hardware'", + "markdown": "Unresolved reference 'Infos_Hardware'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Tkinter/Interface_Tkinter_Template.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 29, + "startColumn": 6, + "charOffset": 2276, + "charLength": 14, + "snippet": { + "text": "Infos_Hardware" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 27, + "startColumn": 1, + "charOffset": 2145, + "charLength": 524, + "snippet": { + "text": "#from nettoyage_du_cache import clear_cache #Bibliotheque permettant de nettoyer les fichiers cache PYTHON\r\n\r\nfrom Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour\r\nfrom Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere\r\nfrom Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "63ea2c60c37896c4", + "equalIndicator/v1": "803cbf961541de8159ee8002e61b761f1572a829a305e0bc2d5f4676988ee454" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'setuptools'", + "markdown": "Unresolved reference 'setuptools'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "setup.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 9, + "startColumn": 6, + "charOffset": 202, + "charLength": 10, + "snippet": { + "text": "setuptools" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 7, + "startColumn": 1, + "charOffset": 136, + "charLength": 115, + "snippet": { + "text": "#And all the depencies will be installed with the Project\r\n\r\nfrom setuptools import setup, find_packages\r\n\r\nsetup(\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "eedc8fa4fd5fd1b9", + "equalIndicator/v1": "81cbec90669aff2eca54cb527414c6c0b042dace2e415f4dda3d4e84ced02d85" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import time'", + "markdown": "Unused import statement `import time`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/Infos_Hardware.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 15, + "startColumn": 1, + "charOffset": 415, + "charLength": 11, + "snippet": { + "text": "import time" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 13, + "startColumn": 1, + "charOffset": 386, + "charLength": 87, + "snippet": { + "text": "import sys\r\nimport datetime\r\nimport time\r\nfrom nettoyage_du_cache import clear_cache\r\n\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "05b96b71cd122737", + "equalIndicator/v1": "8da645ef3c4e42008d701518fd34f6ba83bae20244613480ccbde256eb489a82" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import os #Blibliotheque permettant l'interaction ...'", + "markdown": "Unused import statement `import os #Blibliotheque permettant l'interaction ...`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Kivy/Interface_Kivy.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 10, + "startColumn": 1, + "charOffset": 657, + "charLength": 115, + "snippet": { + "text": "import os #Blibliotheque permettant l'interaction avec le systeme" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 8, + "startColumn": 1, + "charOffset": 560, + "charLength": 435, + "snippet": { + "text": "\r\n#---------------------------------------Importante LIB---------------------------------------\r\nimport os #Blibliotheque permettant l'interaction avec le systeme\r\nimport sys #Blibliotheque permettant l'interaction avec le systeme\r\nimport datetime #Blibliotheque permettant d'obtenir la date\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "9f251956ed152f56", + "equalIndicator/v1": "923153e35a7ff888cb7c05abe2acabd0ca9cf6c6da73729a1e00b2d410ebdb52" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import os'", + "markdown": "Unused import statement `import os`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/Infos_Hardware.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 12, + "startColumn": 1, + "charOffset": 375, + "charLength": 9, + "snippet": { + "text": "import os" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 10, + "startColumn": 1, + "charOffset": 371, + "charLength": 43, + "snippet": { + "text": "\r\n\r\nimport os\r\nimport sys\r\nimport datetime\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "82b20e843bdca3dd", + "equalIndicator/v1": "9b23c7d1436f1e18a5c62edfd4e5b7910dca65ef659afe992c8854ba2459c578" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'find_packages'", + "markdown": "Unresolved reference 'find_packages'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "setup.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 9, + "startColumn": 31, + "charOffset": 227, + "charLength": 13, + "snippet": { + "text": "find_packages" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 7, + "startColumn": 1, + "charOffset": 136, + "charLength": 115, + "snippet": { + "text": "#And all the depencies will be installed with the Project\r\n\r\nfrom setuptools import setup, find_packages\r\n\r\nsetup(\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "fe524cb8c68b9c13", + "equalIndicator/v1": "a04dd66785f1871fbe281c0cf814a0941930d0825fd1ad5cf8087cb1d0a4da97" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'Infos_Hardware'", + "markdown": "Unresolved reference 'Infos_Hardware'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Kivy/Interface_Kivy.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 28, + "startColumn": 6, + "charOffset": 2210, + "charLength": 14, + "snippet": { + "text": "Infos_Hardware" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 26, + "startColumn": 1, + "charOffset": 2130, + "charLength": 473, + "snippet": { + "text": "#print(USERNAME) #Test debug\r\n\r\nfrom Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour\r\nfrom Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere\r\nfrom Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "a882647c1cda7104", + "equalIndicator/v1": "a7a4b5de29ef155d5a2986991fffcc9cad091b2919dcdd581b0141972e68be45" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "error", + "message": { + "text": "Unresolved reference 'CPU_usage'", + "markdown": "Unresolved reference 'CPU_usage'" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Template_UI/RASPBIAN/Kivy/Interface_Kivy.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 28, + "startColumn": 28, + "charOffset": 2232, + "charLength": 9, + "snippet": { + "text": "CPU_usage" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 26, + "startColumn": 1, + "charOffset": 2130, + "charLength": 473, + "snippet": { + "text": "#print(USERNAME) #Test debug\r\n\r\nfrom Infos_Hardware import CPU_usage #Obtention de l'utilisation du Processeur par le Systeme d'exploitation et ses programmes autour\r\nfrom Infos_Hardware import CPU_temp #Obtention de la Temperature du Processeur sur la carte mere\r\nfrom Infos_Hardware import SoC_info #Obtention des informations concernant le package CPU+GPU\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "7f949e6a019d3ac0", + "equalIndicator/v1": "dabc3248badb39f552bac74b08c52a63b2e364542a16151fc3d68faa54a88939" + }, + "properties": { + "ideaSeverity": "ERROR", + "qodanaSeverity": "Critical" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import serial'", + "markdown": "Unused import statement `import serial`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/nettoyage_du_cache.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 8, + "startColumn": 1, + "charOffset": 199, + "charLength": 13, + "snippet": { + "text": "import serial" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 6, + "startColumn": 1, + "charOffset": 109, + "charLength": 128, + "snippet": { + "text": "#Aides : https://blog.mozilla.org/webdev/2015/10/27/eradicating-those-nasty-pyc-files/\r\n\r\nimport serial\r\nimport time\r\nimport os\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "de78f8cf639f900a", + "equalIndicator/v1": "de30d63998c44276c091ad3f30b5e3da05e677c767bf2c07302e2a01fd14dc0f" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + }, + { + "ruleId": "PyUnresolvedReferencesInspection", + "kind": "fail", + "level": "warning", + "message": { + "text": "Unused import statement 'import datetime'", + "markdown": "Unused import statement `import datetime`" + }, + "locations": [ + { + "physicalLocation": { + "artifactLocation": { + "uri": "Services/Infos_Hardware.py", + "uriBaseId": "SRCROOT" + }, + "region": { + "startLine": 14, + "startColumn": 1, + "charOffset": 398, + "charLength": 15, + "snippet": { + "text": "import datetime" + }, + "sourceLanguage": "Python" + }, + "contextRegion": { + "startLine": 12, + "startColumn": 1, + "charOffset": 375, + "charLength": 96, + "snippet": { + "text": "import os\r\nimport sys\r\nimport datetime\r\nimport time\r\nfrom nettoyage_du_cache import clear_cache\r" + }, + "sourceLanguage": "Python" + } + }, + "logicalLocations": [ + { + "fullyQualifiedName": "FR_Template", + "kind": "module" + } + ] + } + ], + "partialFingerprints": { + "equalIndicator/v2": "c997cea98533a6d7", + "equalIndicator/v1": "feecc833f37f9f1999726210ba883b9458b92a7007083f527f997a692f562487" + }, + "properties": { + "ideaSeverity": "WARNING", + "qodanaSeverity": "High" + } + } + ], + "configProfile": "starter", + "deviceId": "14062415656a898-a1e7-4aac-882a-9c7ba36ed1e5", + "qodanaNewResultSummary": { + "moderate": 777, + "high": 21, + "total": 798 + } + } + } + ], + "properties": { + "runTimestamp": "1718401380762" + } +} \ No newline at end of file diff --git a/qodana.yaml b/qodana.yaml new file mode 100644 index 0000000..e4cc9d6 --- /dev/null +++ b/qodana.yaml @@ -0,0 +1,28 @@ +#-------------------------------------------------------------------------------# +# Qodana analysis is configured by qodana.yaml file # +# https://www.jetbrains.com/help/qodana/qodana-yaml.html # +#-------------------------------------------------------------------------------# +version: "1.0" +#Specify inspection profile for code analysis +profile: + name: qodana.starter +#Enable inspections +#include: +# - name: +#Disable inspections +#exclude: +# - name: +# paths: +# - +#Execute shell command before Qodana execution (Applied in CI/CD pipeline) +#bootstrap: sh ./prepare-qodana.sh +#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline) +#plugins: +# - id: #(plugin id can be found at https://plugins.jetbrains.com) +#Specify Qodana linter for analysis (Applied in CI/CD pipeline) +linter: jetbrains/qodana-:latest +exclude: + - name: All + paths: + - Services + - Template_UI diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..01b3bfa --- /dev/null +++ b/requirements.txt @@ -0,0 +1,13 @@ +pyserial~=3.2.1 + +#Unidecode==1.0.23 +#Unirest==1.1.7 +#urllib3==1.26.5 +#requests==2.20.0 +#pyserial==3.2.1 +#pydub==0.23.1 +#Cython==0.29.5 +#Kivy==1.10.1 + +setuptools~=68.2.0 +psutil~=5.9.8 \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..25f64c3 --- /dev/null +++ b/setup.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python +# -*- coding: UTF-8 -*- + + +#HOW INSTALL AND USE THIS PROJECT: +#in the console : sudo python setup.py install +#And all the depencies will be installed with the Project + +from setuptools import setup, find_packages + +setup( + name='FR_Template', + version="1.13.73", + author='Franck Rochat', + author_email='rochat.franck@gmail.com', + description='The Starter Pack.', + url='https://github.com/Franck1333/FR_Template', + license='lgpl', + packages=find_packages(), + include_package_data=True, + install_requires=["Unidecode","Unirest","urllib3","requests","pydub","pyserial","Cython","kivy"], #Get the Dependencies from Pypi (pip install) + #dependency_links=[''], #Get the Dependencies via HTTP(s) +)