python - What's the standard way to document a namedtuple? -

-

looking clean code using namedtuple hold multiple variables passing through number of functions. below simplified example (i have few more additional arguments).

before:

def my_function(session_cass, session_solr, session_mysql, some_var, another): """blah blah.  args:     session_cass (session): cassandra session execute queries with.     session_solr (solrconnection): solr connection execute requests with.     session_mysql (connection): mysql connection execute queries with.     some_var (str): yada yada.     (int): yada yada. """

after:

def my_function(sessions, some_var, another): """blah blah.  args:     sessions (namedtuple): holds database sessions.     some_var (str): yada yada.     (int): yada yada. """

for docstrings, i've been following google style guide, addition of types (inspired this post), because makes lot easier keep track of types coming in.

my question is, how go documenting namedtuple in scenario? it's set up, have no information types within namedtuple. there accepted way extend docstring here, or document namedtuple it's defined (not shown)?

i know document class in manor, i'm trying stay away using class don't have purpose other hold variables.

i not familiar google style guide, how this:

for namedtuple or tuple or list or whatever interchangeable go this

def my_function(sessions, some_var, another):     """blah blah.      args:         sessions (sequence): sequence of length n                               holds database sessions.                              in position 0 need bla bla                              in position 1 need ble ble                              ...                              in position n-1 need blu blu         some_var (str): yada yada.         (int): yada yada.     """

on other hand if use attributes of namedtuple, maybe this

def my_function(sessions, some_var, another):     """blah blah.      args:         sessions (object): object holds database sessions.                            need following attributes                             bla_bla ...                            ble_ble ...                              ...                            blu_blu ...         some_var (str): yada yada.         (int): yada yada.     """

for dictionary, how this

def my_function(sessions, some_var, another):     """blah blah.      args:         sessions (map): dictionary-like object holds                          database sessions, need following keys                         bla_bla ...                         ble_ble ...                            ...                         blu_blu ...         some_var (str): yada yada.         (int): yada yada.     """

or 

def my_function(sessions, some_var, another):     """blah blah.      args:         sessions (customclass): holds database sessions.         some_var (str): yada yada.         (int): yada yada.     """

in each instance ask minimum functionality function need work correctly


Comments

Post a Comment

Popular posts from this blog

mysql - Dreamhost PyCharm Django Python 3 Launching a Site -

-
i'm new python/django , created simple django website using pycharm. site works fine running on computer, i'm lost when comes taking site onto host (dreamhost). i'm able upload files correct directories fine, , believe made correct changes database on mysql. i'm not sure go there though. right now, page shows files rather site. direction appreciated. much! you should not run django application using python manage.py runserver on production. how run application on django depends on server (apache, nginx) want use for apache - https://docs.djangoproject.com/en/1.10/howto/deployment/wsgi/modwsgi/ for nginx - https://www.digitalocean.com/community/tutorials/how-to-serve-django-applications-with-uwsgi-and-nginx-on-ubuntu-14-04 the mysql database should, of course, exist , have correct credentials. or, if choose use sqlite, file should accessible, readable , writable www-user (may different depending on linux distributive)
Read more

java - Sending SMS with SMSLib and Web Services -

-
i have made rest web service send smss using hsdpa usb modem. using smslib in java send smss. every time web service invoked, create gateway start service, send message, stop service , remove gateway. takes 20 seconds each message. found starting service takes lot of time. part of code use send smss service.getinstance().addgateway(gateway); service.getinstance().startservice(); outboundmessage msg = new outboundmessage(phonenumber, message); if (service.getinstance().sendmessage(msg)) { result = "message sent successfully!!"; } else { result = "could not send message."; } service.getinstance().stopservice(); service.getinstance().removegateway(gateway);//remove gateway is there way can start service once if not started , use send message when ever web service invoked? why dont group messages , send in 1 go? service.getinstance().sendmessages(messa...
Read more

java - How to resolve The method toString() in the type Object is not applicable for the arguments (InputStream) -

-
i'm trying read json file local machine. @path("/") public class jsonparsing { file f = new file("file.json"); if (f.exists()){ inputstream = new fileinputstream("file.json"); string jsontxt = ioutils.tostring(is); system.out.println(jsontxt); jsonobject json = new jsonobject(jsontxt); string = json.getstring("1000"); system.out.println(a); } } but i'm getting error in tostring() method. possible read .txt file containing json object local machine? if possible, how done? firstly: whenever ask question- add imports well. secondly: yes possible read .txt file containing json object. steps: 1. add maven dependency in pom.xml - <dependency> <groupid>com.googlecode.json-simple</groupid> <artifactid>json-simple</artifactid> <version>1.1.1</version> </dependency> or add jar of dependency. 2.import...
Read more