pyMez Module Specification

Module Naming Convention

GeneralModels

Module Info and Docstring

"""
Graph Models stores sub classes of graphs that define data translations. All edges
or the functions that define translations from one format to another
are found in <a href="./Translations.m.html">`pyMez.Code.DataHandlers.Translations`</a>.
Currently, the module networkx is used to display the graph.

Examples
--------
    #!python
    >>from pyMez import *
    >>image_graph=ImageGraph()
    >>image_graph.set_state('png','my_png.png')
    >>image_graph.move_to_node('EmbeddedHtml')
    >>output=image_graph.data
    >>print output


<a href="../../../Examples/Html/GraphModels_Example.html">GraphModels Example</a>

Requirements
------------
+ [sys](https://docs.python.org/2/library/sys.html)
+ [os](https://docs.python.org/2/library/os.html?highlight=os#module-os)
+ [networkx](http://networkx.github.io/)
+ [numpy](http://www.numpy.org/)
+ [pyMez](https://github.com/aricsanders/pyMez)

Help
---------------
<a href="./index.html">`pyMez.Code.DataHandlers`</a>
<div>
<a href="../../../pyMez_Documentation.html">Documentation Home</a> |
<a href="../../index.html">API Documentation Home</a> |
<a href="../../Examples/Html/Examples_Home.html">Examples Home</a> |
<a href="../../../Reference_Index.html">Index</a>
</div>
   """

Module Imports

Standard Imports

import os

3rd Party Imports

try:
        from Code.DataHandlers.GeneralModels import *
    except:
        print("The module pyMez.Code.DataHandlers.GeneralModels was not found,"
              "please put it on the python path")
        raise  ImportError

Module Constants

S2P_COMPLEX_COLUMN_NAMES=["Frequency","S11","S21","S12","S22"]

Module Functions

def x_squared(x):
  "A function that maps x->x**2"
  return x**2

Module Class Definitions

class MyClass():
  "An empty class for demonstration"
  pass

Module Scripts

def test_f(x_test=2):
    "Tests the function f"
    print("The Result of f({0}) is {1}".format(x_test,f(x_test)))

Module Runner

if __name__ == '__main__':

$python ModuleName.py

I usually just call module script(s) of interest here.

if __name__=='__main__':
  test_f()

</ol> Notes:

The word py in my code is always lowercase
The words HTML and XML are always capitalized
If there is a case sensitive quantity in the name of a function it has it's original case get_Id()

Avoid relative imports such as from . import a, instead inject a folder above it into sys.path and import the module using the full name space, this keeps the module from breaking when called as a script.

sys.path.append(os.path.join(os.path.dirname( __file__ ), '..','..'))
try:
 from Code.Utils.Alias import *
 METHOD_ALIASES=1
except:
 print("The module pyMez.Code.Utils.Alias was not found")
 METHOD_ALIASES=0
 pass

An example¶

#-----------------------------------------------------------------------------
# Name:        alias.py
# Purpose:     Function that provides exec string to define common aliases for 
#              for functions
# Author:      Aric Sanders
# Created:     2/21/2016
# License:     MIT License
#-----------------------------------------------------------------------------
""" Module that defines functions for handling alias definitions in Classes """

#-------------------------------------------------------------------------------
# Standard imports

import re
import types

#-------------------------------------------------------------------------------
# Module Functions

def alias(object):
    """ Creates aliases that map all non built-in methods to  
    both lowerCapitalCase and all_lower_with_underscore naming conventions the
    output is a list of strings to be used with exec(list[i]) """

    old_names=[]
    split_name=[]
    exec_list=[]
    new_name=''

    # Get all the atributes without __ in the begining
    for attribute in dir(object):
        if not re.match('_',attribute):
            try:
                if type(eval('object.%s'%attribute)) is types.MethodType:
                    old_names.append(attribute)
            except:pass
    # If they are camelCase make them all lower with underscores or vice versa
    for name in old_names:
        if re.search(r'[A-Z]+',name) and not re.search(r'_',name):
            split_upper_case=re.split(r'[A-Z]+',name)
            upper_matches=re.findall(r'[A-Z]+',name)
            for index,piece in enumerate(split_upper_case):
                if index<len(upper_matches):
                    new_name=new_name+piece+'_'+upper_matches[index].lower()
                else:
                    new_name=new_name+piece
            exec_list.append(('self.'+new_name+'='+'self.'+name))

        elif re.search(r'_',name):
            split_name=name.split('_')
            for index,piece in enumerate(split_name):
                if index==0:
                    new_name=piece
                else :
                    new_name=new_name+piece.title()
            exec_list.append(('self.'+new_name+'='+'self.'+name))
        #else: pass
    return exec_list

#-------------------------------------------------------------------------------
# Class Definitions

class MyTestClass():
    """ A class to test the alias function: call it in a for loop inside of 
    __init__() method """

    def __init__(self):
        self.littleAttribue=[]
        self.i_like_underscores=[]
        # this calls and executes the alias function
        for command in alias(self):
            exec(command)

    def myFunctionNumberOne(self):
        pass
    def my_function_number_two(self):
        pass
    def my_funtion_Number_three(self):
        pass

#-------------------------------------------------------------------------------
# Module Scripts
def test_alias():
    print " Before making the instance the attributes defined are:"
    for attribute in dir(MyTestClass):
        print 'Attribute Name: %s'%(attribute)
    new=MyTestClass()

    print " After making the instance the attributes defined are:"
    for attribute in dir(new):
        print 'Attribute Name: %s'%(attribute)
#-------------------------------------------------------------------------------
# Module Runner

if __name__ == '__main__':

    test_alias()