Naming conventions for regular variables

Collapse
This topic is closed.
X
X
 
  • Time
  • Show
Clear All
new posts
  • mk

    Naming conventions for regular variables


    This document gives coding conventions for the Python code comprising the standard library in the main Python distribution. Please see the companion informational PEP describing style guidelines for the C code in the C implementation of Python.


    "Function Names

    Function names should be lowercase, with words separated by underscores
    as necessary to improve readability."

    However, this PEP does not recommend any particular style for naming
    regular (local) variables.

    Personally I like "mixedCase" , however using both styles looks a bit weird:

    def some_function_n ame(someVariabl eName, anotherVar)

    Naming both functions and variables using "lowercase with underscore
    separator between words for readability" leads to confusing function
    names with variable names - and distinguishing between variables and
    function names just by looking at them would be nice.

    Recommendations ?





  • Ben Finney

    #2
    Re: Naming conventions for regular variables

    mk <mrkafk@gmail.c omwrites:
    This document gives coding conventions for the Python code comprising the standard library in the main Python distribution. Please see the companion informational PEP describing style guidelines for the C code in the C implementation of Python.

    >
    "Function Names
    >
    Function names should be lowercase, with words separated by
    underscores as necessary to improve readability."
    >
    However, this PEP does not recommend any particular style for naming
    regular (local) variables.
    Yes, it does: "Method Names and Instance Variables" applies. Any
    object that isn't a class is an "instance", to be named according to
    that section.
    Personally I like "mixedCase"
    Nothing in PEP 8 allows mixedCase (except for the rare degenerate case
    where you're constrained to closely follow an existing naming
    convention). It's always TitleCase or lowercase, with or without
    underscores.
    Naming both functions and variables using "lowercase with underscore
    separator between words for readability" leads to confusing function
    names with variable names - and distinguishing between variables and
    function names just by looking at them would be nice.
    Functions are first-class objects in Python, and many non-function
    objects are callable. So, such an arbitrary distinction wouldn't be
    helpful.

    It's more sensible to distinguish by *usage*: is it being called or
    not?
    Recommendations ?
    Follow PEP 8, including the avoidance of mixedCase.

    --
    \ “I went to a general store. They wouldn't let me buy anything |
    `\ specifically.† —Steven Wright |
    _o__) |
    Ben Finney

    Comment

    Working...