sphinx-toolbox Demo - AutoNamedTuple

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> Animal ( name , voice ) [source]

An animal.

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. name ( str ) – The name of the animal.

  2. voice ( str ) – The animal’s voice.

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> Employee ( name , id = 3 ) [source]

Represents an employee.

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. name ( str ) – The employee’s name

  2. id ( int ) – The employee’s ID number

<{{ sig_prename_tag }} class="sig-name descname"> is_executive ( ) [source]

Returns whether the employee is an executive.

Executives have ID numbers < 10.

Return type{% if docutils_version >= (0, 18) %} : {% endif %}

bool

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> Movie ( name , year , based_on ) [source]

Represents a movie.

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. name ( str ) – The name of the movie.

  2. year ( int ) – The movie’s release year.

  3. based_on ( str ) – Alias for field number 2

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> Foo ( a , b , c ) [source]

Bases: NamedTuple

A Namedtuple

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. a ( int ) – An integer

  2. b ( str ) – A string

  3. c ( str ) – C’s doc

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> Traditional ( a , b , c )

Bases: namedtuple()

A traditional Namedtuple

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. a – Alias for field number 0

  2. b – Alias for field number 1

  3. c – Alias for field number 2

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> NoDocstring ( a , b , c ) [source]

Bases: NamedTuple

NoDocstring(a, b, c)

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. a ( int ) – An integer

  2. b ( str ) – Alias for field number 1

  3. c ( str ) – C’s doc

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> NoDocstring ( a , b , c ) [source]

NoDocstring(a, b, c)

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. a ( int ) – An integer

  2. b ( str ) – Alias for field number 1

  3. c ( str ) – C’s doc

namedtuple <{{ sig_prename_tag }} class="sig-prename descclassname"> autonamedtuple_demo. <{{ sig_prename_tag }} class="sig-name descname"> CustomisedNew ( values ) [source]

typing.NamedTuple .

Fields{% if docutils_version >= (0, 18) %} : {% endif %}
  1. a – Alias for field number 0

  2. b – Alias for field number 1

  3. c – Alias for field number 2

This function takes a single argument, the Movie to watch. The name of the movie can be accessed with the name attribute.