alexweav / adaf Goto Github PK
View Code? Open in Web Editor NEWNetworked data acquisition and delivery for automobiles. TTU undergrad Capstone project
License: MIT License
Networked data acquisition and delivery for automobiles. TTU undergrad Capstone project
License: MIT License
Use PascalCase for classes.
class MyClass(object):
Use PascalCase for methods.
def MyMethod(args):
Python prefers snake_case for local and class variables.
self.my_variable
this_is_a_local_variable
or
self.myVariable
thisIsALocalVariable
CAPS_WITH_UNDERSCORES for global constants
PI
This is intended to be an object-oriented project. Functions should never be outside of a class, unless they are trivial or simplify an API.
i don't have an example for this one
Exceptions include a main
function, as well as auxiliary/related things such as command-line argument parsing, etc. Should argument parsing be a class???
Never access class variables directly. Expose properties for variables that you want to be readable or modifiable.
DO: var = object.GetVariable()
DON'T: var = object.variable
If a class doesn't inherit from anything, inherit directly from object
. Thoughts on this?
DO:class MyClass(object):
DON'T:class MyClass:
Abstract methods are known to suck in Python. Common practice seems to involve throwing a NotImplementedError
for abstract methods with a helpful error message. Thoughts?
class MyAbstractClass(object):
def MyAbstractMethod(args):
raise NotImplementedError(`Calling an abstract method`)
Add an I
to the beginning of the name of any interface class.
DO:class IMyInterface(object):
DON'T:class MyInterface(object):
Don't use C++ style multiple inheritance. Classes can inherit from an arbitrary number of interfaces, but only one abstract or concrete class.
DO: class MyClass(BaseClass, IMyInterface):
DON'T: class MyClass(BaseClass, OtherBaseClass):
Python supports typed annotations for method signatures. Do we want this?
I personally hate dynamic typing with object oriented programming, so I would be for it. Not everyone likes it though since the syntax is a little unusual.
WITHOUT:
def AddFive(num):
return num + 5
WITH:
def AddFive(num: int) -> int:
return num + 5
Add a comment above each class.
"""
Does something interesting.
"""
class MyClass(object):
Add a comment above each method. Do we want this? Keep in mind this includes stuff as simple as properties, which could seem unnecessary. Could reduce this to "Add a comment above each non-trivial method."
NONTRIVIAL:
"""
Does something interesting.
"""
def MyMethod(args):
TRIVIAL:
"""
Gets the IP Address
"""
def GetIp():
Use triple quotes for comments describing classes, methods, etc.
Use #
-comments for simple line annotations.
"""
I describe MyClass
"""
class MyClass(object):
statement1
statement2 # Does something special
statement3
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.