Pythonic Naming conventions

[psbasha]

Hi,

I would like to know what naming conventions we can follow for the following types of variables/sequences :

Variables :
-------------

Integer
Float
Boolean

Sequences :
--------------

Strings
List
Dictionary
Tuples

File

I understand that Python variables are "Dynamically Typed" ,that is one of the feature of it.But how the developer differentiate with different sequences or variables he is working with.

Thanks in advance
PSB

[bartonc]

Hi,

I would like to know what naming conventions we can follow for the following types of variables/sequences :

Variables :
-------------

Integer
Float
Boolean

Sequences :
--------------

Strings
List
Dictionary
Tuples

File

I understand that Python variables are "Dynamically Typed" ,that is one of the feature of it.But how the developer differentiate with different sequences or variables he is working with.

Thanks in advance
PSB

As I was reading your post, the words "Dynamically Typed" were running through my mind. I'm glad that you have that understanding. Because a function don't care about the type of it's arguments, I've settled on a nameType (sometimes long_nameType) naming "convention" for myself. But that mostly applies to instances of class objects. I don't differentiate between mutibles and non-mutibles the way that you have. As a rule, I use:
class: ThisClassName
def: ThisFuncName

useofThisClass = ThisClassName()
thisType = ThisFuncName()

Integer
Float
I just use descriptive names like
loopCount, distance, etc. Just wait 'til you meet Decimal and others that are not built in, but are very commonly used.

Boolean
conditionFlag

Strings
whateverStr

List
listofList

Dictionary
describeDict

Tuples
samehereTuple

File
alwaysFile

I hope that is useful to you. Thanks for posting. Keep it up.

[bartonc]

As I was reading your post, the words "Dynamically Typed" were running through my mind. I'm glad that you have that understanding. Because a function don't care about the type of it's arguments, I've settled on a nameType (sometimes long_nameType) naming "convention" for myself. But that mostly applies to instances of class objects. I don't differentiate between mutibles and non-mutibles the way that you have. As a rule, I use:
class: ThisClassName
def: ThisFuncName

useofThisClass = ThisClassName()
thisType = ThisFuncName()

Integer
Float
I just use descriptive names like
loopCount, distance, etc. Just wait 'til you meet Decimal and others that are not built in, but are very commonly used.

Boolean
conditionFlag

Strings
whateverStr

List
listofList

Dictionary
describeDict

Tuples
samehereTuple

File
alwaysFile

I hope that is useful to you. Thanks for posting. Keep it up.

Also, for short loops where the whole life of a counter can be seen in just a few line, i, j, k, do just fine. And for long life instance variablea shared by many methods, I use_very_descriptive_names which may not need the Type at the end. This is all just personal style and I have seen "conventions" change over the years. If you look at the style that Tkinter was written in, you'll see what I think is a very common "pythonic" way of naming things. On the other hand, wxPython ToolKit uses C naming conventions because of the underlieing implementation and is the style that I prefer.

[bvdet]

Hi,

I would like to know what naming conventions we can follow for the following types of variables/sequences :

Variables :
-------------

Integer
Float
Boolean

Sequences :
--------------

Strings
List
Dictionary
Tuples

File

I understand that Python variables are "Dynamically Typed" ,that is one of the feature of it.But how the developer differentiate with different sequences or variables he is working with.

Thanks in advance
PSB

Take a look at this: http://www.python.org/doc/essays/styleguide/

Following are some guidelines I use:

single letter names for class instances ('a', 'b', 'c')
single letter name ('f') for an open file if contained in a small block of code
'i' (integer) when executing a range iteration
LineLineIntersect3D, Plane3D - class definitions
clip_hole, add_weld, radius_cut, data_Defaults_path, import_data, trueAngleBetweenMembers, formatDict, formatPtList - descriptive names for functions
PointRotate3D - descriptive names for functions with major functionality
pt_list or ptList - a list of points
bm_list or bmList - a list of beams
dd1, dd2, memDict, conn_dict - dictionaries

rot_arg - tuple (I mostly use lists)
ptWP, pt1, p1 - point objects
mem1 - the first selected member object

m, bm, col, mem, key - iteration on a list of:
material
beams
columns
members
dictionary keys

A descriptive name similar to lists - strings, integers, and floats
no_spa (number of spaces), left_dist (the distance from the left end)

I am still in 2.3 - not using sets yet

[bartonc]

Take a look at this: http://www.python.org/doc/essays/styleguide/

Thanks BV. I hadn't read that before. I am amazed how much of THE MAN's style I have picked up over the years just by reading library modules. My whitespace thinking exactly matches his. Great link (I bookmarked it).

[psbasha]

Hi,

What naming conventions has to be followed for the Class Variables and Methods?.How to differentiate the Private ,Protected and Public Class Variables and Methods?Is there any conventions has to be followed.


Thankls & REgards
PSB

[bartonc]

Hi,

What naming conventions has to be followed for the Class Variables and Methods?.How to differentiate the Private ,Protected and Public Class Variables and Methods?Is there any conventions has to be followed.


Thankls & REgards
PSB

Guess you haven't found this yet.

[psbasha]

Hi ,

I am not able to decide the Naming conventions for the following.

Variables :
--------------

Float
Integer
String
List
Dictionary
Tuples
File

Class Names

Private,Protected and Public
Class Variables

Class Methods

Functions

I have looked for various material in Internet .I am not able to get the consistency naming conventions.

Each one is following thier own naming conventions.

Thanks in advacne
PSB

[bartonc]

Hi ,

I am not able to decide the Naming conventions for the following.

Variables :
--------------

Float
Integer
String
List
Dictionary
Tuples
File

Class Names

Private,Protected and Public
Class Variables

Class Methods

Functions

I have looked for various material in Internet .I am not able to get the consistency naming conventions.

Each one is following thier own naming conventions.

Thanks in advacne
PSB

It really comes down to a matter of personal style.
BV gave a great link. I gave suggestions. Please try to keep one post per topic so that all info ends up in one place. Thanks.

[psbasha]

Hi ,

The naming conventions for UI in Python are similar to that of Application.

UI Variables and Methods

- Handlers
- Control Variables ( ID's,EDIT Box,Combo Box)
- Class Variables
- Call back names
- Event Handlers
- Other


Thanks in Advacne
PSB

[psbasha]

Hi,

I am confused which naming conventions to be followed for Variables ,Classes and Functions.In www.Python.org ,the naming conventions looks fine.When I refer the .py files of the Python4.2.I am confused with different mixture of naming conventions used in different (.py) files for the variables,Classes,Methods,function etc.

Could anybody help me in better understanding of which naming has to be used and when it has to be used.

Thanks in advacne
PSB

[bartonc]

Hi ,

The naming conventions for UI in Python are similar to that of Application.

UI Variables and Methods

- Handlers
- Control Variables ( ID's,EDIT Box,Combo Box)
- Class Variables
- Call back names
- Event Handlers
- Other


Thanks in Advacne
PSB

Let's try to keep a topic in a single thread, please.

[bartonc]

Hi,

I am confused which naming conventions to be followed for Variables ,Classes and Functions.In www.Python.org ,the naming conventions looks fine.When I refer the .py files of the Python4.2.I am confused with different mixture of naming conventions used in different (.py) files for the variables,Classes,Methods,function etc.

Could anybody help me in better understanding of which naming has to be used and when it has to be used.

Thanks in advacne
PSB

The Father of Python clearly states:
"Naming Conventions
The naming conventions of Python's library are a bit of a mess, so we'll never get this completely consistent -- nevertheless, here are some guidelines."

[psbasha]

Let's try to keep a topic in a single thread, please.

Thanks for the reply

Still I need the clarification for the UI variables as mentioned in the discusiion.

Could you please clarifyit in more elaborately,so that I Can start working on my applications using the standard conventions.

-PSB

[bartonc]

Thanks for the reply

Still I need the clarification for the UI variables as mentioned in the discusiion.

Could you please clarifyit in more elaborately,so that I Can start working on my applications using the standard conventions.

-PSB

I use mixedCaseWords for all class instances, like GUI elements. The prefixed word is the name followed by TheClassOfTheElement. BTW, You shouldn't (although Tkinter allows it) do things like:

myClass[attribute] = value

. Always call the setters of GUI objects (or any class for that matter).

[psbasha]

How to differentiate the Class variables/Methods?.Whether we have to use the same variable names as ordinary variable names.

Private:
Protected:
Public:


Thanks in advance
PSB

[bartonc]

Quoting from http://www.python.org/doc/essays/styleguide/#names

Method Names
Hmm, the story is largely the same as for functions. When using ILU, here's a good convention: use CapWords for methods published via an ILU interface. Use lowercase for methods accessed by other classes or functions that are part of the implementation of an object type. Use one leading underscore for "internal" methods and instance variables when there is no chance of a conflict with subclass or superclass attributes or when a subclass might actually need access to them. Use two leading underscores (class-private names, enforced by Python 1.4) in those cases where it is important that only the current class accesses an attribute. (But realize that Python contains enough loopholes so that an insistent user could gain access nevertheless, e.g. via the __dict__ attribute. Only ILU or Python's restricted mode will XXX

[psbasha]

Quoting from http://www.python.org/doc/essays/styleguide/#names

Method Names
Hmm, the story is largely the same as for functions. When using ILU, here's a good convention: use CapWords for methods published via an ILU interface. Use lowercase for methods accessed by other classes or functions that are part of the implementation of an object type. Use one leading underscore for "internal" methods and instance variables when there is no chance of a conflict with subclass or superclass attributes or when a subclass might actually need access to them. Use two leading underscores (class-private names, enforced by Python 1.4) in those cases where it is important that only the current class accesses an attribute. (But realize that Python contains enough loopholes so that an insistent user could gain access nevertheless, e.g. via the __dict__ attribute. Only ILU or Python's restricted mode will XXX

What is this ILU stands for ?

[bartonc]

What is this ILU stands for ?

Check it out here.