Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Commit

Permalink
docs: call out pylint limitations in readme
Browse files Browse the repository at this point in the history
Re: https://github.com/googleapis/python-vision/issues/6, the generated methods on the `ImageAnnotatorClient` class do not play nicely with Pylint. As a workaround, let's add this to the README so that future users have a chance to see this limitation up-front and save themselves some time.
  • Loading branch information
danielcressman authored and Daniel Cressman committed Oct 6, 2021
1 parent ca56a71 commit a4301dd
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,23 @@ Example Usage
'features': [{'type_': vision.Feature.Type.FACE_DETECTION}]
})
Known Limitations
~~~~~~~~~~~~~~~~~

Pylint Does Not Work Out Of The Box
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Pylint throws errors by default when checking code that uses feature methods on the ``ImageAnnotatorClient`` class, such as ``label_detection()`` or ``text_detection()``.

As a workaround, member checking on all methods of the ``ImageAnnotatorClient`` can be disabled using Pylint's ``generated-members`` option. To do this on a line-by-line basis, add a comment like ``# pylint: disable=no-member`` to suppress this error. To do this for a whole project, you can add the following lines to a ``.pylintrc`` file in your project::

[TYPECHECK]
generated-members=<<REGULAR EXPRESSION>>

Substitute a regular expression of your choosing that matches all lines for which you want to disable this error check. For example, if you choose a convention of naming your ``ImageAnnotatorClient`` variables ``image_annotator_client``, then your regex could be ``image_annotator_client.*`` or something similar.


Next Steps
~~~~~~~~~~

Expand Down

0 comments on commit a4301dd

Please sign in to comment.