Skip to content

Improve Krita API - Document

Grum 999 requested to merge grum/krita:grum999/python_api_improve_document into master

Following MR #2147

I've made implementation here of all things for which no review was requested in initial MR (at the end the initial MR #2147 will be cancelled when I'll finish to commit all change in separate MR)

In synthesis:

  • Document: Grids & Guides implementation review
  • Document: miscellaneous minor improvement
  • Palette: minor improvement related to method name (try to get something more consistent in API)
  • SIP: manage class cast properly for Python class bindings
  • Also updated some classes documentation

Notes

  • No implementation here about signals (relative to Document class); it will be managed in a separate MR
  • No implementation here about MirrorAxis; it will be managed in a separate MR

Test Plan

For main change, Grids & Guides, 2 scripts are added:

  • plugins/extensions/pykrita/manual_tests/documents_gridsconfig_test_script.py
  • plugins/extensions/pykrita/manual_tests/documents_guidesconfig_test_script.py

Formalities Checklist

  • I confirmed this builds.
  • I confirmed Krita ran and the relevant functions work.
  • I tested the relevant unit tests and can confirm they are not broken. (If not possible, don't hesitate to ask for help!)
  • I made sure my commits build individually and have good descriptions as per KDE guidelines.
  • I made sure my code conforms to the standards set in the HACKING file.
  • I can confirm the code is licensed and attributed appropriately, and that unattributed code is mine, as per KDE Licensing Policy.
  • Does the patch add a user-visible feature? If yes, is there a documentation MR ready for it at Krita Documentation Repository?

Reminder: the reviewer is responsible for merging the patch, this is to ensure at the least two people can build the patch. In case a patch breaks the build, both the author and the reviewer should be contacted to fix the build. If this is not possible, the commits shall be reverted, and a notification with the reasoning and any relevant logs shall be sent to the mailing list, kimageshop@kde.org.

Merge request reports