Python: Standard way to denote return and parameter types -

-

Is there a standard, pathological way to express the parameter type and the type of function back?

I am looking for a notation:

  • help
  • can be identified by IDE <
  • (Preferrably) described in PEP

    I have seen some examples like: 

      "" " Varies with: Ultimate Timestamp: Formatted Date Display: Type Timestamp: Str or Unicode: Ultimate Priority: Priority Number: Type Priority: str or Unicode: Ultimate Priority_name: Priority G: type preference name: str or unicode: the ultimate message: to display message: type message: str or unicode: returns: formatted string: rtype: str or unicode ""

    However, I'm not sure how official / supported this format is.

Python DocString mainly has a 3/4 format competition. To see an overview, the old format, now closed, is the Epytext for Epydoc based on Javadoc style. Perhaps more popular is the redesigned text (REST) ​​ for the Sphinx format. The Google style is also quite used. And of course, Google style-inspired Numpydoc .

In what context can you mention in official / standard way.

Here are some examples of its criteria type and representation of return type in each format:

- Epytext / Javadoc 

  "" @ Param 1: type the type of paragraph 1 type type param1: param1 type @ return: return value details @ type: return type type "" "

- rest 

  "": Param param1: Description of the parameter: type param1: type of param1: return: return value details: retype: the value of returned value "" "

- Google 

 " "" Argus: Ultimate 1: Description of Parameter `paragraph 1` param2 (str, optional ): Details of the parameter no. Returns: BULL: Correct or inaccurate on the basis of the result. "" "

- Parameter ---------- param1: Description of int parameter` param1` param2: { Description of 'value1', 'value2'} parameter with two possible values. Return ------- int Returned Value "" "

Converting

< P> Note that if you do not have any docstring or you want to change your dosstring format for your Python project, you can use it.


Comments

Post a Comment

Popular posts from this blog

java - org.apache.http.ProtocolException: Target host is not specified -

-
I have written a simple httprequest / response code and I am getting this error below: I used to type in my classpath httpclient, httpcore, common -Codecs and general logging. I am very new to Java and I do not know what's going on here. Please help me. code: import org.apache.http.client.HttpClient; Import org.apache.http.client.methods.HttpGet; Import org.apache.http.HttpResponse; Import org.apache.http.impl.client.HttpClientBuilder; Import org.apache.http.Header; Import org.apache.http.HttpHeaders; Public class UnshorteningUrl {public static zero main (string [] args throws exception {HttpGet request = zero; HTTP Client Client = HTTP ClientBuilder.credit (). Build (); Try {Request = New HTTP Gate ("trib.me/1lBFzSi"); HttpResponse httpResponse = client.execute (request); Header [] header = httpResponse.getHeaders (HttpHeaders.LOCATION); // Preconditions.checkState (headers.length == 1); String new url = header [0] .getValue (); System.out.println ("new url...
Read more

java - Gradle dependencies: compile project by relative path -

-
Is it possible to specify a dependency on another gradeal project in the granular (in android studios) outside the current project limits? For example, with a relative path like this: dependence {collection project ('../../ stdlib / dagger'}} MyApp (path / user / foo / workspace / mypad) The app (Path / User / Foo / Workspace / MyPass / App) And I have an Android Library Project with 3 subdomules: stdlib (path is / user / foo / Utilities (Path / User / Foo / Workspace / Stadlib / Utilis) http (Path / User / Foo / Workspace / Stadlib / HT) / Li> What I have to do is compile the Dagger, Util, http module in the MyApp project. The Stidelib Library module under heavy development And MyApp will grow in the form of Growth, so I do not want to push them into a Mewen repository. I am a little change. is likely to add another Gredle projects in some way? I will push the study library into the Maven repository after the source is in search of a temp...
Read more

ruby on rails - Object doesn't support #inspect when used with .include -

-
So I have participated in a glitch error that I do not even know how to debug. I am very new to the railing, so it has kicked my ass well when I use the .includes (school) seen by the student, it gives a blue box error, But when I look at any other model and .includes (school) , the school works just fine. class student & lt; ActiveRecord :: Base has has_many: relationships, foreign_key: "liker_id", dependent :: has_many: matches, foreign_key: "student_1_id", dependent :: deleted belong_to: school belong_to: conference belong_to: would_you_rather belong_to: home city belong_to: year is_to: Major and class school & lt; on the console activatecord :: Affiliate for the base: conference includes: respondent, class: "school", foreign_key: "rival_id" (e.g. For: School) Select SQL generated Select "School". * "School" from "school" "ID" IN (1) error message back NoMethodError: u...
Read more