Metadata-Version: 2.1
Name: flake8-test-name
Version: 0.1.2
Summary: Invalid test name checker, plugin for flake8
Home-page: https://github.com/bagerard/flake8-test-name
Maintainer: Bastien Gerard
Maintainer-email: bast.gerard@gmail.com
License: MIT License
Description: Test Name function validator (Flake8 plugin)
        ============================================
        
        .. image:: https://github.com/bagerard/flake8-test-name/actions/workflows/github-actions.yml/badge.svg
           :alt: Build status
           :target: https://github.com/bagerard/flake8-test-name/actions/workflows/github-actions.yml
        
        .. image:: https://coveralls.io/repos/github/bagerard/flake8-test-name/badge.svg
           :alt: Coverage Status
           :target: https://coveralls.io/github/bagerard/flake8-test-name
        
        An extension for `Flake8 <https://pypi.python.org/pypi/flake8>`_ to make sure
        that test function name follows a given convention
        
        
        Plugin for Flake8
        -----------------
        
        When both Flake8 and ``flake8-test-name`` are installed, the plugin
        will show up when displaying the version of ``flake8``::
        
          $ flake8 --version
          3.6.0 (flake8-test-name: 0.1.2, […]
        
        
        Parameters
        ----------
        
        This module can be configured in 2 ways:
        --test-func-name-validator-module={path_to_a_python_file}
        or
        --test-func-name-validator-regex={regex_pattern}
        
        E.g usage with the regex::
        
          $ flake8 myproject/tests/sample.py --test-func-name-validator-regex="test_funky_convention_.*" --select=TN101
        
          >>myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)
        
        
        
        E.g usage with the module::
        Since regex aren't a good fit for all the use case, you can also provide your own validator
        as a python file with a function named "test_function_name_validator".
        
        Assuming you have a funky_validator.py file with the following content::
        
            def test_function_name_validator(func_name: str):
                return func_name.startswith("test_funkyconvention")
        
        You can then configure the plugin with::
        
            $ flake8 myproject/tests/sample.py --test-func-name-validator-module=./funky_validator.py --select=TN101
        
            >>myproject/tests/sample.py:14:1: TN101 test function name does not match the convention (test_invalid_method_sample)
        
        Error codes
        -----------
        
        This plugin is using the following error codes:
        
        +----------------------------------------------------------------+
        | Test function name validation                                  |
        +-------+--------------------------------------------------------+
        | TN101 | TN101 test function name does not match the convention |
        +-------+--------------------------------------------------------+
        
        
        Operation
        ---------
        
        The plugin will go through all files, look for directories named "tests", and validate method
        starting with `test_` against your validator.
        
        
        Changes
        -------
        
        0.1.2 - 2021-03-21
        ``````````````````
        * minor refactoring and doc improvement
        
        0.1.1 - 2021-03-19
        ``````````````````
        * Initial release
        
Keywords: flake8 test name convention
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Description-Content-Type: text/x-rst
