delta/python-packages/gitlab.git/gitlab/base.py, branch jlvillal/project_groups

chore: fix issue with adding type-hints to 'manager' attribute

2021-11-22T06:37:56+00:00

When attempting to add type-hints to the the 'manager' attribute into
a RESTObject derived class it would break things.

This was because our auto-manager creation code would automatically
add the specified annotated manager to the 'manager' attribute. This
breaks things.

Now check in our auto-manager creation if our attribute is called
'manager'. If so we ignore it.

refactor: use new-style formatting for named placeholders

2021-11-08T22:11:40+00:00

refactor: use f-strings for string formatting

2021-11-06T03:45:01+00:00

docs: fix a few typos

2021-09-18T20:34:18+00:00

There are small typos in:
- docs/gl_objects/deploy_tokens.rst
- gitlab/base.py
- gitlab/mixins.py
- gitlab/v4/objects/features.py
- gitlab/v4/objects/groups.py
- gitlab/v4/objects/packages.py
- gitlab/v4/objects/projects.py
- gitlab/v4/objects/sidekiq.py
- gitlab/v4/objects/todos.py

Fixes:
- Should read `treatment` rather than `reatment`.
- Should read `transferred` rather than `transfered`.
- Should read `registered` rather than `registred`.
- Should read `occurred` rather than `occured`.
- Should read `overridden` rather than `overriden`.
- Should read `marked` rather than `maked`.
- Should read `instantiate` rather than `instanciate`.
- Should read `function` rather than `fonction`.

chore: convert to using type-annotations for managers

2021-09-08T14:18:48+00:00

Convert our manager usage to be done via type annotations.

Now to define a manager to be used in a RESTObject subclass can simply
do:
      class ExampleClass(CRUDMixin, RESTObject):
          my_manager: MyManager

Any type-annotation that annotates it to be of type *Manager (with the
exception of RESTManager) will cause the manager to be created on the
object.

chore: improve type-hinting for managers

2021-09-07T15:19:39+00:00

The 'managers' are dynamically created. This unfortunately means that
we don't have any type-hints for them and so editors which understand
type-hints won't know that they are valid attributes.

 * Add the type-hints for the managers we define.
 * Add a unit test that makes sure that the type-hints and the
   '_managers' attribute are kept in sync with each other.
 * Add unit test that makes sure specified managers in '_managers'
   have a name ending in 'Managers' to keep with current convention.
 * Make RESTObject._managers always present with a default value of
   None.
 * Fix a type-issue revealed now that mypy knows what the type is

fix: catch invalid type used to initialize RESTObject

2021-06-10T14:39:58+00:00

Sometimes we have errors where we don't get a dictionary passed to
RESTObject.__init__() method. This breaks things but in confusing
ways.

Check in the __init__() method and raise an exception if it occurs.

chore: fix import ordering using isort

2021-05-25T18:54:51+00:00

Fix the import ordering using isort.

https://pycqa.github.io/isort/

chore: mypy: Disallow untyped definitions

2021-04-28T04:04:58+00:00

Be more strict and don't allow untyped definitions on the files we
check.

Also this adds type-hints for two of the decorators so that now
functions/methods decorated by them will have their types be revealed
correctly.

chore: make RESTObject._short_print_attrs always present

2021-04-24T19:10:59+00:00

Always create RESTObject._short_print_attrs with a default value of
None.

This way we don't need to use hasattr() and we will know the type of
the attribute.