Repository navigation
Styling/coding standards #3
Description
Which coding standards/PEP guides are you planning to adhere to.
As this is a python library aimed at python users(presumably) the PEPs would be a good place to start.
Also when implementing the classes there are a couple options regarding the OOP interface as I see it:
- literal translations so
getPos playerbecomesplayer.getPos(). orplayer.get_pos() @propertydecorator to wrap the calls to the DLL to the user so thatgetPos playerbecomesplayer.pos, andplayer setPos [a,b,c]becomesplayer.pos = [a,b,c].- Both of the above, having one approach call the other for example. This illustrates both approaches, and is therefor less pythonic ("one way to do something").
class RV_Object(object):
def __init__(self):
# todo
pass
@property
def pos(self)->tuple:pass
@pos.setter
def pos(self, pos:tuple)->None:pass
def get_pos(self)->tuple: pass # todo
def set_pos(self, pos:tuple)->None: pass # todo
Activity
overfl0 commentedon Apr 10, 2018
Using PEP8 would be a good start ;).
I'd suggest doing as "everyone else does" and increasing the line size limit to 120 chars (with 1080p and even 4k monitors nowadays)
I'm sitting on a fence regarding the camelCase vs snake_notation. I'm used to snake but I also see the benefit of sticking to the original SQF function names. Deep inside me I'd prefer to stick with the original naming (less confusion) but I haven't done enough Arma modding (nor even used Intercept much) to speak authoritatively about this matter.
Tirpitz93 commentedon Apr 10, 2018
Where do you guys stand on replacing
get_*andset_*with a property?If necessary adding aliases to the property.
Also what would the preferred naming convention/ namespace for the class names be?
RV_*Intercept_*Arma_*Tirpitz93 commentedon Apr 10, 2018
I have some boilerplate code here: https://github.com/Tirpitz93/intercept-python/tree/python_classes.
jonpas commentedon Apr 10, 2018
Intercept uses
snake_casefor all SQF wrappers as well, might as well do the same here.