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

Commit

Permalink
docs(readme): add pylint limitations (#246)
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.

Co-authored-by: gcf-merge-on-green[bot] <60162190+gcf-merge-on-green[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people committed Oct 14, 2021
1 parent 06d4de7 commit e4fb61f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.rst
Expand Up @@ -108,6 +108,30 @@ 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 e4fb61f

Please sign in to comment.