Commitde102b1

Joe Boyle

authored and

committed

gh-99908 Update class documentation to use a modernized example

1 parent0769f95 commitde102b1Copy full SHA for de102b1

File tree

+16

-12

lines changed

+16

-12

lines changed

Lines changed: 16 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -738,18 +738,22 @@ Odds and Ends`
`738`	`738`	`=============`
`739`	`739`
`740`	`740`	`Sometimes it is useful to have a data type similar to the Pascal "record" or C`
`741`		`-"struct", bundling together a few named data items. An empty class definition`
`742`		`-will do nicely::`
`743`		`-`
`744`		`- class Employee:`
`745`		`- pass`
`746`		`-`
`747`		`- john = Employee() # Create an empty employee record`
`748`		`-`
`749`		`- # Fill the fields of the record`
`750`		`- john.name = 'John Doe'`
`751`		`- john.dept = 'computer lab'`
`752`		`- john.salary = 1000`
	`741`	`+"struct", bundling together a few named data items. The idiomatic approach`
	`742`	+is to use:mod:`dataclasses` for this purpose::
	`743`	`+`
	`744`	`+ from dataclasses import dataclasses`
	`745`	`+`
	`746`	`+ @dataclass`
	`747`	`+ class Employee:`
	`748`	`+ name: str`
	`749`	`+ dept: str`
	`750`	`+ salary: int`
	`751`	`+`
	`752`	`+ john = Employee("john", "computer lab", 1000)`
	`753`	`+ >>> john.dept`
	`754`	`+ # "computer lab"`
	`755`	`+ >>> john.salary`
	`756`	`+ # '1000'`
`753`	`757`
`754`	`758`	`A piece of Python code that expects a particular abstract data type can often be`
`755`	`759`	`passed a class that emulates the methods of that data type instead. For`

Comments

(0)