summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2022-12-24 15:32:29 (GMT)
committerGitHub <noreply@github.com>2022-12-24 15:32:29 (GMT)
commit3ea6f7fee883faf5f4cf8abfff62deb986b89d53 (patch)
tree4a2e3746a1d41530054fe62f86f20995dcab6706 /Doc
parentecfe468a6ef10e78b1f9ea8418f04bc63d6b62f7 (diff)
downloadcpython-3ea6f7fee883faf5f4cf8abfff62deb986b89d53.zip
cpython-3ea6f7fee883faf5f4cf8abfff62deb986b89d53.tar.gz
cpython-3ea6f7fee883faf5f4cf8abfff62deb986b89d53.tar.bz2
gh-99908: Tutorial: Modernize the 'data-record class' example (GH-100499)
(cherry picked from commit 00afa5066bd45348ed82a38d3442763b2ed1a068) Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/tutorial/classes.rst24
1 files changed, 15 insertions, 9 deletions
diff --git a/Doc/tutorial/classes.rst b/Doc/tutorial/classes.rst
index d7a24b4..5abb767 100644
--- a/Doc/tutorial/classes.rst
+++ b/Doc/tutorial/classes.rst
@@ -737,18 +737,24 @@ Odds and Ends
=============
Sometimes it is useful to have a data type similar to the Pascal "record" or C
-"struct", bundling together a few named data items. An empty class definition
-will do nicely::
+"struct", bundling together a few named data items. The idiomatic approach
+is to use :mod:`dataclasses` for this purpose::
- class Employee:
- pass
+ from dataclasses import dataclasses
- john = Employee() # Create an empty employee record
+ @dataclass
+ class Employee:
+ name: str
+ dept: str
+ salary: int
- # Fill the fields of the record
- john.name = 'John Doe'
- john.dept = 'computer lab'
- john.salary = 1000
+::
+
+ >>> john = Employee('john', 'computer lab', 1000)
+ >>> john.dept
+ 'computer lab'
+ >>> john.salary
+ 1000
A piece of Python code that expects a particular abstract data type can often be
passed a class that emulates the methods of that data type instead. For