├── .flake8 ├── .gitattributes ├── .github └── workflows │ └── python-checks.yml ├── .gitignore ├── .vscode └── settings.json ├── LICENSE ├── README.md ├── manifest.json ├── pyproject.toml ├── requirements ├── anki-qt5.txt ├── anki-qt6.txt └── dev.txt ├── src ├── __init__.py ├── consts.py ├── context_menu.py ├── icon │ ├── close.svg │ └── position.svg ├── inspector.py ├── logger.py ├── utils.py ├── widgets.py └── window_info.py └── tools ├── build_ankiaddon.sh ├── config.sh └── create_symlink_for_windows.sh /.flake8: -------------------------------------------------------------------------------- 1 | # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length 2 | [flake8] 3 | max-line-length = 88 4 | extend-ignore = E203 5 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/python-checks.yml: -------------------------------------------------------------------------------- 1 | name: Python checks 2 | 3 | on: 4 | push: 5 | branches: [master] 6 | pull_request: 7 | 8 | permissions: 9 | contents: read 10 | 11 | jobs: 12 | lint-format-check: 13 | runs-on: ubuntu-latest 14 | 15 | strategy: 16 | matrix: 17 | qt-version: [qt5, qt6] 18 | 19 | steps: 20 | - uses: actions/checkout@v4 21 | 22 | - name: Set up Python 3.9 23 | uses: actions/setup-python@v4 24 | with: 25 | python-version: "3.9" 26 | 27 | - name: Install dependencies 28 | run: | 29 | python -m pip install --upgrade pip 30 | pip install -r ./requirements/dev.txt -r ./requirements/anki-${{ matrix.qt-version }}.txt 31 | 32 | - name: Black 33 | run: black src --check 34 | 35 | - name: Flake8 36 | run: flake8 src 37 | 38 | - name: isort 39 | run: isort src -c 40 | 41 | - name: Mypy 42 | run: mypy src 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Anki 2 | meta.json 3 | 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | *.egg-info/ 27 | .installed.cfg 28 | *.egg 29 | MANIFEST 30 | 31 | # PyInstaller 32 | # Usually these files are written by a python script from a template 33 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 34 | *.manifest 35 | *.spec 36 | 37 | # Installer logs 38 | pip-log.txt 39 | pip-delete-this-directory.txt 40 | 41 | # Unit test / coverage reports 42 | htmlcov/ 43 | .tox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | 53 | # Translations 54 | *.mo 55 | *.pot 56 | 57 | # Django stuff: 58 | *.log 59 | local_settings.py 60 | db.sqlite3 61 | 62 | # Flask stuff: 63 | instance/ 64 | .webassets-cache 65 | 66 | # Scrapy stuff: 67 | .scrapy 68 | 69 | # Sphinx documentation 70 | docs/_build/ 71 | 72 | # PyBuilder 73 | target/ 74 | 75 | # Jupyter Notebook 76 | .ipynb_checkpoints 77 | 78 | # pyenv 79 | .python-version 80 | 81 | # celery beat schedule file 82 | celerybeat-schedule 83 | 84 | # SageMath parsed files 85 | *.sage.py 86 | 87 | # Environments 88 | .env 89 | .venv 90 | env/ 91 | venv/ 92 | ENV/ 93 | env.bak/ 94 | venv.bak/ 95 | 96 | # Spyder project settings 97 | .spyderproject 98 | .spyproject 99 | 100 | # Rope project settings 101 | .ropeproject 102 | 103 | # mkdocs documentation 104 | /site 105 | 106 | # mypy 107 | .mypy_cache/ 108 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "[python]": { 3 | "editor.codeActionsOnSave": { 4 | "source.organizeImports": true 5 | } 6 | }, 7 | "files.eol": "\n", 8 | "files.exclude": { 9 | "**/__pycache__/": true, 10 | "**/.git": true, 11 | "**/.mypy_cache/": true 12 | }, 13 | "files.insertFinalNewline": true, 14 | "git.ignoreLimitWarning": true, 15 | "git.untrackedChanges": "hidden", 16 | "python.analysis.extraPaths": [ 17 | "C:/anki/qt/", 18 | "C:/anki/pylib" 19 | ], 20 | "python.formatting.provider": "black", 21 | "python.linting.enabled": true, 22 | "python.linting.flake8Args": [ 23 | "--config=.flake8" 24 | ], 25 | "python.linting.flake8Enabled": true, 26 | "python.linting.mypyEnabled": true, 27 | "search.exclude": { 28 | ".vscode/": true 29 | }, 30 | "workbench.editor.enablePreview": false 31 | } 32 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AnkiWebView Inspector 2 | --- 3 | See [Wiki](https://github.com/hikaru-y/anki21-addon-ankiwebview-inspector/wiki) for documentaion. 4 | -------------------------------------------------------------------------------- /manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "ankiweb_id": "31746032", 3 | "name": "AnkiWebView Inspector", 4 | "package": "31746032" 5 | } 6 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 88 3 | 4 | [tool.isort] 5 | # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#how-black-wraps-lines 6 | profile = "black" 7 | known_first_party = ["anki", "aqt"] 8 | 9 | [tool.mypy] 10 | python_version = "3.9" 11 | disallow_untyped_defs = true 12 | -------------------------------------------------------------------------------- /requirements/anki-qt5.txt: -------------------------------------------------------------------------------- 1 | aqt[qt5] 2 | -------------------------------------------------------------------------------- /requirements/anki-qt6.txt: -------------------------------------------------------------------------------- 1 | aqt[qt6] 2 | -------------------------------------------------------------------------------- /requirements/dev.txt: -------------------------------------------------------------------------------- 1 | black 2 | flake8 3 | isort 4 | mypy 5 | -------------------------------------------------------------------------------- /src/__init__.py: -------------------------------------------------------------------------------- 1 | from . import context_menu 2 | 3 | context_menu.register_context_menu() 4 | -------------------------------------------------------------------------------- /src/consts.py: -------------------------------------------------------------------------------- 1 | ADDON_NAME = "AnkiWebView Inspector" 2 | CONTEXT_MENU_ITEM_LABEL = "Inspect" 3 | -------------------------------------------------------------------------------- /src/context_menu.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from aqt import gui_hooks, mw, qt, webview 4 | from aqt.editor import EditorWebView 5 | from aqt.webview import AnkiWebView 6 | 7 | from . import consts 8 | from .inspector import MainWindowInspector, SubWindowInspector 9 | from .widgets import InspectorDock 10 | from .window_info import windows 11 | 12 | 13 | def inspect_main_window(inspected_page: webview.AnkiWebPage) -> None: 14 | if inspected_page.devToolsPage(): 15 | inspected_page.triggerAction(qt.QWebEnginePage.WebAction.InspectElement) 16 | else: 17 | inspector: MainWindowInspector 18 | dock: InspectorDock | None 19 | if dock := mw.findChild(InspectorDock): 20 | inspector = dock.widget() 21 | inspector.inspected_page_changed = True 22 | else: 23 | inspector = MainWindowInspector() 24 | inspector.set_page(inspected_page) 25 | 26 | 27 | def inspect_sub_window( 28 | inspected_page: webview.AnkiWebPage, 29 | window_widget: qt.QWidget, 30 | target_widget: qt.QWidget, 31 | insert_pos: int, 32 | ) -> None: 33 | if inspected_page.devToolsPage(): 34 | inspected_page.triggerAction(qt.QWebEnginePage.WebAction.InspectElement) 35 | else: 36 | target_widget.setSizePolicy( 37 | qt.QSizePolicy.Policy.Expanding, qt.QSizePolicy.Policy.Expanding 38 | ) 39 | inspector = SubWindowInspector(window_widget, target_widget, insert_pos) 40 | inspector.set_page(inspected_page) 41 | layout: qt.QBoxLayout = window_widget.layout() 42 | layout.insertWidget(insert_pos, inspector.splitter, 1) 43 | 44 | 45 | def on_webview_will_show_context_menu(webview: AnkiWebView, menu: qt.QMenu) -> None: 46 | window = webview.window() 47 | if window_info := next( 48 | (i for i in windows if type(window) is i.get_widget()), None 49 | ): 50 | if window_info.main_window: 51 | # mw.web, mw.bottomWeb, mw.toolbarWeb 52 | menu.addAction( 53 | consts.CONTEXT_MENU_ITEM_LABEL, 54 | lambda: inspect_main_window(webview.page()), 55 | ) 56 | else: 57 | # clayout, previewer, stats, etc. 58 | target: qt.QWidget 59 | if isinstance(window_info.target, str): 60 | target = getattr(window, window_info.target, webview) 61 | else: 62 | target = window_info.target(window) 63 | insert_pos = window_info.insert_pos 64 | menu.addAction( 65 | consts.CONTEXT_MENU_ITEM_LABEL, 66 | lambda: inspect_sub_window(webview.page(), window, target, insert_pos), 67 | ) 68 | 69 | 70 | def on_editor_will_show_context_menu( 71 | editor_webview: EditorWebView, menu: qt.QMenu 72 | ) -> None: 73 | menu.addAction( 74 | consts.CONTEXT_MENU_ITEM_LABEL, 75 | lambda: inspect_sub_window( 76 | editor_webview.page(), editor_webview.editor.widget, editor_webview, 0 77 | ), 78 | ) 79 | 80 | 81 | def register_context_menu() -> None: 82 | gui_hooks.webview_will_show_context_menu.append(on_webview_will_show_context_menu) 83 | gui_hooks.editor_will_show_context_menu.append(on_editor_will_show_context_menu) 84 | -------------------------------------------------------------------------------- /src/icon/close.svg: -------------------------------------------------------------------------------- 1 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /src/icon/position.svg: -------------------------------------------------------------------------------- 1 | 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /src/inspector.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from aqt import gui_hooks, mw, qt, webview 4 | 5 | from .logger import log_widget_destroyed, logger 6 | from .utils import get_icon 7 | from .widgets import InspectorDock, InspectorSplitter 8 | 9 | 10 | class BaseInspector(qt.QWidget): 11 | inspected_page: webview.AnkiWebPage 12 | label = qt.QLabel 13 | 14 | def __init__(self, parent: qt.QWidget) -> None: 15 | super().__init__(parent) 16 | self.setAttribute(qt.Qt.WidgetAttribute.WA_DeleteOnClose) 17 | log_widget_destroyed(self) 18 | self.webview = qt.QWebEngineView(self) 19 | log_widget_destroyed(self.webview) 20 | self.setup_layout() 21 | 22 | def setup_layout(self) -> None: 23 | vbox = qt.QVBoxLayout() 24 | vbox.setContentsMargins(0, 0, 0, 0) 25 | vbox.setSpacing(0) 26 | topbar = self.create_topbar() 27 | vbox.addLayout(topbar) 28 | vbox.addWidget(self.webview) 29 | self.setLayout(vbox) 30 | 31 | def set_page(self, inspected_page: webview.AnkiWebPage) -> None: 32 | self.inspected_page = inspected_page 33 | # web channel 34 | channel = self.inspected_page.webChannel() 35 | self.webview.page().setWebChannel(channel) 36 | 37 | self.webview.loadFinished.connect(self.on_load_finished) 38 | self.webview.page().setInspectedPage(self.inspected_page) 39 | 40 | @qt.pyqtSlot(bool) 41 | def on_load_finished(self, ok: bool) -> None: 42 | logger.debug("on_load_finished") 43 | self._on_load_finished() 44 | self.webview.loadFinished.disconnect(self.on_load_finished) 45 | 46 | def _on_load_finished(self) -> None: 47 | pass 48 | 49 | @qt.pyqtSlot(int) 50 | def on_zoom_spinbox_value_changed(self, value: int) -> None: 51 | self.webview.setZoomFactor(value / 100) 52 | # https://stackoverflow.com/questions/12892129/how-to-prevent-qspinbox-from-automatically-highlighting-contents 53 | self.zoom_spinbox.lineEdit().deselect() 54 | 55 | def create_topbar(self) -> qt.QHBoxLayout: 56 | hbox = qt.QHBoxLayout() 57 | hbox.setSpacing(4) 58 | self.label = qt.QLabel(self) 59 | hbox.addWidget(self.label) 60 | hbox.addStretch() 61 | 62 | # Zoom 63 | self.zoom_spinbox = qt.QSpinBox(self) 64 | self.zoom_spinbox.setFocusPolicy(qt.Qt.FocusPolicy.NoFocus) 65 | self.zoom_spinbox.setRange(50, 150) 66 | self.zoom_spinbox.setValue(100) 67 | self.zoom_spinbox.setSingleStep(10) 68 | self.zoom_spinbox.setToolTip("Zoom level") 69 | self.zoom_spinbox.setSuffix(" %") 70 | self.zoom_spinbox.valueChanged.connect( 71 | self.on_zoom_spinbox_value_changed, qt.Qt.ConnectionType.QueuedConnection 72 | ) 73 | hbox.addWidget(self.zoom_spinbox) 74 | 75 | # Buttons 76 | default_button_height = qt.QPushButton().sizeHint().height() 77 | button_size = qt.QSize(default_button_height, default_button_height) 78 | 79 | position_button = qt.QPushButton(self) 80 | position_button.setFocusPolicy(qt.Qt.FocusPolicy.NoFocus) 81 | position_button.setMaximumSize(button_size) 82 | position_button.setIcon(get_icon("icon/position.svg")) 83 | position_button.setToolTip("Toggle position (right/bottom)") 84 | position_button.clicked.connect(self.on_position_button_clicked) 85 | hbox.addWidget(position_button) 86 | 87 | close_button = qt.QPushButton(self) 88 | close_button.setFocusPolicy(qt.Qt.FocusPolicy.NoFocus) 89 | close_button.setMaximumSize(button_size) 90 | close_button.setIcon(get_icon("icon/close.svg")) 91 | close_button.setToolTip("Close Inspector") 92 | close_button.clicked.connect(self.on_close_button_clicked) 93 | hbox.addWidget(close_button) 94 | 95 | return hbox 96 | 97 | def inspect_element(self) -> None: 98 | self.inspected_page.triggerAction(qt.QWebEnginePage.WebAction.InspectElement) 99 | 100 | def set_label(self, text: str) -> None: 101 | self.label.setText(text) 102 | self.label.setToolTip(text) 103 | 104 | 105 | class MainWindowInspector(BaseInspector): 106 | def __init__(self) -> None: 107 | self.dock = InspectorDock(mw) 108 | super().__init__(parent=self.dock) 109 | 110 | # https://doc.qt.io/qt-6/qdockwidget.html#appearance 111 | # > Custom size hints, minimum and maximum sizes and size policies 112 | # > should be implemented in the child widget. 113 | self.webview.setMinimumSize(200, 200) 114 | 115 | self.webview.urlChanged.connect(self.set_dock_title) 116 | self.dock.setWidget(self) 117 | self.inspected_page_changed = False 118 | 119 | gui_hooks.profile_did_open.append(self.on_profile_did_open) 120 | self.destroyed.connect( 121 | lambda *_: gui_hooks.profile_did_open.remove(self.on_profile_did_open) 122 | ) 123 | 124 | def on_profile_did_open(self) -> None: 125 | # switching profiles with inspector open may hide dock widget 126 | self.dock.show() 127 | 128 | def _on_load_finished(self) -> None: 129 | self.inspect_element() 130 | if self.inspected_page_changed: 131 | self.set_dock_title() 132 | else: 133 | self.add_dock_to_mw() 134 | 135 | def add_dock_to_mw(self) -> None: 136 | # It seems that this process needs to be done at the very end 137 | # in order to accurately highlight the right-clicked element. 138 | mw.addDockWidget(qt.Qt.DockWidgetArea.RightDockWidgetArea, self.dock) 139 | 140 | def set_dock_title(self) -> None: 141 | self.dock.setWindowTitle(self.inspected_page.title()) 142 | 143 | @qt.pyqtSlot() 144 | def on_close_button_clicked(self) -> None: 145 | self.dock.close() 146 | 147 | @qt.pyqtSlot() 148 | def on_position_button_clicked(self) -> None: 149 | self.dock.toggle_area() 150 | 151 | 152 | class SubWindowInspector(BaseInspector): 153 | def __init__( 154 | self, 155 | window_widget: qt.QWidget, 156 | target_widget: qt.QWidget, 157 | original_pos: int, 158 | ) -> None: 159 | super().__init__(parent=window_widget) 160 | self.window_widget = window_widget 161 | self.target_widget = target_widget 162 | 163 | # splitter 164 | self.splitter = InspectorSplitter(self.window_widget) 165 | self.splitter.addWidget(target_widget) 166 | 167 | self.original_pos = original_pos 168 | 169 | @qt.pyqtSlot() 170 | def on_position_button_clicked(self) -> None: 171 | self.splitter.toggle_orientation() 172 | 173 | def _on_load_finished(self) -> None: 174 | self.set_label(f"Inspector({self.inspected_page.title()})") 175 | self.inspect_element() 176 | self.splitter.addWidget(self) 177 | self.splitter.equalize_sizes() 178 | 179 | @qt.pyqtSlot() 180 | def on_close_button_clicked(self) -> None: 181 | self.close() 182 | self.window_widget.layout().insertWidget(self.original_pos, self.target_widget) 183 | self.splitter.close() 184 | -------------------------------------------------------------------------------- /src/logger.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import sys 3 | 4 | from aqt.qt import QWidget 5 | 6 | logger = logging.getLogger(__name__) 7 | 8 | # Set to `DEBUG` to enable debug messages. Be sure to revert to `WARNING` 9 | # before committing. 10 | logger.setLevel(logging.WARNING) 11 | 12 | formatter = logging.Formatter( 13 | '[%(levelname)s](%(asctime)s) File "%(pathname)s",' 14 | ' line %(lineno)d, in %(funcName)s: "%(message)s"' 15 | ) 16 | 17 | # console handler 18 | ch = logging.StreamHandler(sys.stdout) 19 | ch.setLevel(logging.DEBUG) 20 | ch.setFormatter(formatter) 21 | logger.addHandler(ch) 22 | 23 | 24 | def log_widget_destroyed(widget: QWidget) -> None: 25 | widget.destroyed.connect( 26 | lambda: logger.debug(f"{widget.__class__.__name__} destroyed!") 27 | ) 28 | -------------------------------------------------------------------------------- /src/utils.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | from aqt import qt, theme 4 | 5 | 6 | # https://lists.qt-project.org/pipermail/qt-interest-old/2008-December/000776.html 7 | def get_icon(path: str) -> qt.QIcon: 8 | icon = qt.QIcon(str(Path(__file__).resolve().parent / path)) 9 | if theme.theme_manager.night_mode: 10 | img = icon.pixmap(32).toImage() 11 | img.invertPixels() 12 | icon = qt.QIcon(qt.QPixmap.fromImage(img)) 13 | return icon 14 | -------------------------------------------------------------------------------- /src/widgets.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from aqt import qt 4 | 5 | from . import consts 6 | from .logger import log_widget_destroyed 7 | 8 | 9 | class InspectorDock(qt.QDockWidget): 10 | def __init__(self, parent: qt.QMainWindow) -> None: 11 | super().__init__(parent) 12 | self.setObjectName(consts.ADDON_NAME) 13 | self.setAttribute(qt.Qt.WidgetAttribute.WA_DeleteOnClose) 14 | log_widget_destroyed(self) 15 | self.parent = parent 16 | 17 | # make sure the panel is docked to main window at startup 18 | self.setFloating(False) 19 | 20 | # allowed areas 21 | self.setAllowedAreas( 22 | qt.Qt.DockWidgetArea.RightDockWidgetArea 23 | | qt.Qt.DockWidgetArea.BottomDockWidgetArea 24 | ) 25 | 26 | def toggle_area(self) -> None: 27 | """Right <-> Bottom""" 28 | if self.isFloating(): 29 | self.setFloating(False) 30 | else: 31 | new_area = ( 32 | self.parent.dockWidgetArea(self) # current area 33 | ^ qt.Qt.DockWidgetArea.RightDockWidgetArea 34 | ^ qt.Qt.DockWidgetArea.BottomDockWidgetArea 35 | ) 36 | self.parent.addDockWidget(new_area, self) 37 | 38 | 39 | class InspectorSplitter(qt.QSplitter): 40 | def __init__(self, parent: qt.QDialog) -> None: 41 | super().__init__(parent) 42 | self.setObjectName(consts.ADDON_NAME) 43 | self.setAttribute(qt.Qt.WidgetAttribute.WA_DeleteOnClose) 44 | log_widget_destroyed(self) 45 | self.setChildrenCollapsible(False) 46 | self.setOrientation(qt.Qt.Orientation.Vertical) 47 | 48 | def toggle_orientation(self) -> None: 49 | """Right <-> Bottom""" 50 | new_orientation = ( 51 | self.orientation() 52 | ^ qt.Qt.Orientation.Vertical 53 | ^ qt.Qt.Orientation.Horizontal 54 | ) 55 | self.setOrientation(new_orientation) 56 | self.equalize_sizes() 57 | 58 | def equalize_sizes(self) -> None: 59 | # https://stackoverflow.com/questions/43831474/how-to-equally-distribute-the-width-of-qsplitter 60 | self.setSizes([10000, 10000]) 61 | -------------------------------------------------------------------------------- /src/window_info.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from dataclasses import dataclass 4 | from operator import attrgetter 5 | from typing import Callable, Union 6 | 7 | import aqt 8 | from aqt import qt 9 | 10 | from .logger import logger 11 | 12 | 13 | @dataclass 14 | class WindowInfo: 15 | dotted_attr: str 16 | target: Union[str, Callable[[qt.QWidget], qt.QWidget]] = "" 17 | insert_pos: int = 0 18 | main_window: bool = False 19 | 20 | def get_widget(self) -> qt.Qwidget | None: 21 | try: 22 | return attrgetter(self.dotted_attr)(aqt) 23 | except Exception as e: 24 | logger.debug(e) 25 | return None 26 | 27 | 28 | windows = ( 29 | WindowInfo(dotted_attr="main.AnkiQt", main_window=True), 30 | WindowInfo(dotted_attr="browser.card_info.CardInfoDialog"), 31 | WindowInfo(dotted_attr="browser.previewer.BrowserPreviewer"), 32 | WindowInfo(dotted_attr="changenotetype.ChangeNotetypeDialog"), 33 | WindowInfo(dotted_attr="clayout.CardLayout", target="mainArea", insert_pos=1), 34 | WindowInfo(dotted_attr="deckoptions.DeckOptionsDialog"), 35 | WindowInfo(dotted_attr="emptycards.EmptyCardsDialog"), 36 | WindowInfo(dotted_attr="fields.FieldDialog"), 37 | WindowInfo(dotted_attr="stats.NewDeckStats"), 38 | WindowInfo( 39 | dotted_attr="addons.ConfigEditor", target=lambda window: window.form.splitter 40 | ), 41 | ) 42 | -------------------------------------------------------------------------------- /tools/build_ankiaddon.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -euC 4 | 5 | this_dir=$(cd "$(dirname "$0")" && pwd -P) 6 | root_dir=$(dirname "${this_dir}") 7 | source "${this_dir}/config.sh" 8 | dist_dir="${root_dir}/dist" 9 | mkdir -p "${dist_dir}" 10 | ankiaddon="${dist_dir}/${package}.ankiaddon" 11 | 12 | function main() { 13 | rm -f -v "$ankiaddon" 14 | echo "Building ${package}.ankiaddon ..." 15 | cd "${root_dir}/src" 16 | zip -r ${ankiaddon} . -x "meta.json" "*.log" "__pycache__/*" ".mypy_cache/*" 17 | cd "${root_dir}" 18 | zip ${ankiaddon} "manifest.json" "README.md" "LICENSE" 19 | echo "Build done!" 20 | } 21 | 22 | main 23 | -------------------------------------------------------------------------------- /tools/config.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -euC 4 | 5 | package="ankiwebview_inspector" 6 | -------------------------------------------------------------------------------- /tools/create_symlink_for_windows.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This script requires administrator privileges 4 | 5 | set -euC 6 | 7 | export MSYS=winsymlinks:nativestrict 8 | 9 | this_dir=$(cd "$(dirname "$0")" && pwd -P) 10 | root_dir=$(dirname "${this_dir}") 11 | source "${this_dir}/config.sh" 12 | addons21_dir="/D/_anki/addons21" 13 | 14 | # Windows -> POSIX 15 | # appdata=$(echo "/${APPDATA}" | sed -e 's/\\/\//g' -e 's/://') 16 | 17 | ln -f -s "${root_dir}/src/" "${addons21_dir}/${package}" 18 | --------------------------------------------------------------------------------