flake8-simple-string-first-arg


Nameflake8-simple-string-first-arg JSON
Version 0.1.2 PyPI version JSON
download
home_page
SummaryThis Flake8 plugin for checking that first param of callable is simple string.
upload_time2023-01-16 14:42:58
maintainer
docs_urlNone
authorKozyar Valeriy
requires_python>=3.8,<4.0
licenseMIT
keywords flake8-simple-string-first-arg flake8 plugin simple string first arg simple first arg
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # flake8-simple-string-first-arg

This *Flake8* plugin for checking that first param of callable object is simple string. 
Plugin will check for specified callable objects that 
it is not allowed to use f-sting, .format method, string concat and % statement for first parameter

# Quick Start Guide

1. Install ``flake8-simple-string-first-arg`` from PyPI with pip:

        pip install flake8-simple-string-first-arg

2. Configure a mark that you would like to validate:

        cd project_root/
        vi setup.cfg

3. Add to file following: 
   
        [flake8]  
        simple-string-first-arg = SomeClassName, OtherClassName:url

3. Run flake8::

        flake8 .

# flake8 codes

   * SFA100: In calling {CallableName} f-string is used
   * SFA200: In calling {CallableName} string.format() is used
   * SFA300: In calling {CallableName} string concatenation ("+") is used
   * SFA400: In calling {CallableName} "%" is used

# Settings

**simple-string-first-arg**  
It specifies a list of name of callable objects, that should have simple string as first arg.
You can add the name of the argument via `:` to check if it is passed as a named parameter.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "flake8-simple-string-first-arg",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "flake8-simple-string-first-arg,flake8,plugin,simple string,first arg,simple first arg",
    "author": "Kozyar Valeriy",
    "author_email": "monqpepers@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/bc/12/660f6e20589ea34629df0c1127fb2edd9a300ee8ff8da32c9165e7980296/flake8_simple_string_first_arg-0.1.2.tar.gz",
    "platform": null,
    "description": "# flake8-simple-string-first-arg\n\nThis *Flake8* plugin for checking that first param of callable object is simple string. \nPlugin will check for specified callable objects that \nit is not allowed to use f-sting, .format method, string concat and % statement for first parameter\n\n# Quick Start Guide\n\n1. Install ``flake8-simple-string-first-arg`` from PyPI with pip:\n\n        pip install flake8-simple-string-first-arg\n\n2. Configure a mark that you would like to validate:\n\n        cd project_root/\n        vi setup.cfg\n\n3. Add to file following: \n   \n        [flake8]  \n        simple-string-first-arg = SomeClassName, OtherClassName:url\n\n3. Run flake8::\n\n        flake8 .\n\n# flake8 codes\n\n   * SFA100: In calling {CallableName} f-string is used\n   * SFA200: In calling {CallableName} string.format() is used\n   * SFA300: In calling {CallableName} string concatenation (\"+\") is used\n   * SFA400: In calling {CallableName} \"%\" is used\n\n# Settings\n\n**simple-string-first-arg**  \nIt specifies a list of name of callable objects, that should have simple string as first arg.\nYou can add the name of the argument via `:` to check if it is passed as a named parameter.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "This Flake8 plugin for checking that first param of callable is simple string.",
    "version": "0.1.2",
    "split_keywords": [
        "flake8-simple-string-first-arg",
        "flake8",
        "plugin",
        "simple string",
        "first arg",
        "simple first arg"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9f1d6f6b25b0648181e36229b65a65ea9f45405d4e5b5f7cc4a7a9c28b978e7",
                "md5": "d60b3bd4ebf903b73d66d03c7660bc0a",
                "sha256": "8ad12885d9194623e1ecf1674a06d318b421dbe21ddbeed980cc0f7e54e097d5"
            },
            "downloads": -1,
            "filename": "flake8_simple_string_first_arg-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d60b3bd4ebf903b73d66d03c7660bc0a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 4661,
            "upload_time": "2023-01-16T14:42:56",
            "upload_time_iso_8601": "2023-01-16T14:42:56.881244Z",
            "url": "https://files.pythonhosted.org/packages/f9/f1/d6f6b25b0648181e36229b65a65ea9f45405d4e5b5f7cc4a7a9c28b978e7/flake8_simple_string_first_arg-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bc12660f6e20589ea34629df0c1127fb2edd9a300ee8ff8da32c9165e7980296",
                "md5": "7ca3819cb273aa190c65928c1617236a",
                "sha256": "4fa2e75e8d21d543136ab95d6cac7fa0384658252cf93c8b0608decfda33a8ef"
            },
            "downloads": -1,
            "filename": "flake8_simple_string_first_arg-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "7ca3819cb273aa190c65928c1617236a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 4425,
            "upload_time": "2023-01-16T14:42:58",
            "upload_time_iso_8601": "2023-01-16T14:42:58.440762Z",
            "url": "https://files.pythonhosted.org/packages/bc/12/660f6e20589ea34629df0c1127fb2edd9a300ee8ff8da32c9165e7980296/flake8_simple_string_first_arg-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-16 14:42:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "flake8-simple-string-first-arg"
}
        
Elapsed time: 0.04138s