No documentation on how to write plugins. #556

Activity

1. asottile

   added

   component:docs

   on Apr 3, 2021
2. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @sigmavirus24 on Jan 18, 2017, 05:09

   Would you prefer more examples of plugins or just an interface definition that plugins need to satisfy?
3. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @graingert on Jan 18, 2017, 05:29

   Now that you've given me the option, I'd like both :D
4. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @sigmavirus24 on Jan 21, 2017, 05:32

   @graingert then I expect you to do the review on the pull request that will be made for this. ;)
5. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @graingert on Jan 22, 2017, 03:34

   Sure. If you can provide a mypy abc that would be even better
6. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @pawamoy on Jun 18, 2020, 07:17

   +1!

   I just started trying to write a check plugin for Flake8, and nowhere in the docs could I find an example of what the plugin should look like. The docs mention add_options and parse_options, but do not show where to put them.

   • Should my plugin inherit from a base class?
   • Should it declare some attributes?
   • What methods should I implement?

   OK, at this point I just searched for a recent plugin to see how it's written.
   It would be nice if the docs showed a minimal example, something like this:

   class MyFlake8Plugin:
       name = 'my-flake8-plugin'
       version = 0.2.3
   
       my_option = None
       default_my_option = 3
   
       def __init__(self, tree, filename: str):
           self.filename = filename
           self.tree = tree
           if MyFlake8Plugin.my_option is None:
               MyFlake8Plugin.my_option = self.default_my_option 
   
       @classmethod
       def add_options(cls, parser) -> None:
           parser.add_option(
               '--my-option ',
               type=int,
               parse_from_config=True,
               default=cls.default_my_option,
           )
   
       @classmethod
       def parse_options(cls, options) -> None:
           cls.my_option = int(options.my_option )
   
       def run(self):
           errors = [...]  # compute errors with self.tree
           for error in errors:
               yield (
                   error.lineno,
                   error.col_offset,
                   f"ABC{error.number} {error.message}",
                   type(self),
               )
7. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @asottile on Jun 18, 2020, 09:17

   fwiw, I threw together a youtube video about making a plugin that might be helpful
8. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @pawamoy on Jun 18, 2020, 09:56

   Thanks, I love astpretty, I wish I knew it before!
9. asottile commented on Apr 3, 2021

   

   asottile

   on Apr 3, 2021

   MemberAuthor

   More actions

   In GitLab by @spookylukey on Dec 21, 2020, 02:50

   Thanks @pawamoy that's really helpful.

   I found a simpler case that is possible using just a function. This one operates on physical lines, so the expected returned items are just (text_offset_into_line, error_message)

   def no_bare_typing_import(physical_line):
       if physical_line == 'import typing\n':
           return [(0, "XXX001 'import typing' found, use 'from typing import ...' "
                       "instead for shorter type signatures")]
   
   
   no_bare_typing_import.name = no_bare_typing_import.__name__
   no_bare_typing_import.version = '1.0'