123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- <!doctype html><!-- This is a valid HTML5 document. -->
- <!-- Screen readers, SEO, extensions and so on. -->
- <html lang="fr">
- <!-- Has to be within the first 1024 bytes, hence before the `title` element
- See: https://www.w3.org/TR/2012/CR-html5-20121217/document-metadata.html#charset -->
- <meta charset="utf-8">
- <!-- Why no `X-UA-Compatible` meta: https://stackoverflow.com/a/6771584 -->
- <!-- The viewport meta is quite crowded and we are responsible for that.
- See: https://codepen.io/tigt/post/meta-viewport-for-2015 -->
- <meta name="viewport" content="width=device-width,initial-scale=1">
- <!-- Required to make a valid HTML5 document. -->
- <title>dataklasses: A different spin on dataclasses. (archive) — David Larlet</title>
- <meta name="description" content="Publication mise en cache pour en conserver une trace.">
- <!-- That good ol' feed, subscribe :). -->
- <link rel="alternate" type="application/atom+xml" title="Feed" href="/david/log/">
- <!-- Generated from https://realfavicongenerator.net/ such a mess. -->
- <link rel="apple-touch-icon" sizes="180x180" href="/static/david/icons2/apple-touch-icon.png">
- <link rel="icon" type="image/png" sizes="32x32" href="/static/david/icons2/favicon-32x32.png">
- <link rel="icon" type="image/png" sizes="16x16" href="/static/david/icons2/favicon-16x16.png">
- <link rel="manifest" href="/static/david/icons2/site.webmanifest">
- <link rel="mask-icon" href="/static/david/icons2/safari-pinned-tab.svg" color="#07486c">
- <link rel="shortcut icon" href="/static/david/icons2/favicon.ico">
- <meta name="msapplication-TileColor" content="#f7f7f7">
- <meta name="msapplication-config" content="/static/david/icons2/browserconfig.xml">
- <meta name="theme-color" content="#f7f7f7" media="(prefers-color-scheme: light)">
- <meta name="theme-color" content="#272727" media="(prefers-color-scheme: dark)">
- <!-- Documented, feel free to shoot an email. -->
- <link rel="stylesheet" href="/static/david/css/style_2021-01-20.css">
- <!-- See https://www.zachleat.com/web/comprehensive-webfonts/ for the trade-off. -->
- <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_regular.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
- <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_bold.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
- <link rel="preload" href="/static/david/css/fonts/triplicate_t4_poly_italic.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)" crossorigin>
- <link rel="preload" href="/static/david/css/fonts/triplicate_t3_regular.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
- <link rel="preload" href="/static/david/css/fonts/triplicate_t3_bold.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
- <link rel="preload" href="/static/david/css/fonts/triplicate_t3_italic.woff2" as="font" type="font/woff2" media="(prefers-color-scheme: dark)" crossorigin>
- <script>
- function toggleTheme(themeName) {
- document.documentElement.classList.toggle(
- 'forced-dark',
- themeName === 'dark'
- )
- document.documentElement.classList.toggle(
- 'forced-light',
- themeName === 'light'
- )
- }
- const selectedTheme = localStorage.getItem('theme')
- if (selectedTheme !== 'undefined') {
- toggleTheme(selectedTheme)
- }
- </script>
-
- <meta name="robots" content="noindex, nofollow">
- <meta content="origin-when-cross-origin" name="referrer">
- <!-- Canonical URL for SEO purposes -->
- <link rel="canonical" href="https://github.com/dabeaz/dataklasses#questions-and-answers">
-
- <body class="remarkdown h1-underline h2-underline h3-underline em-underscore hr-center ul-star pre-tick" data-instant-intensity="viewport-all">
-
-
- <article>
- <header>
- <h1>dataklasses: A different spin on dataclasses.</h1>
- </header>
- <nav>
- <p class="center">
- <a href="/david/" title="Aller à l’accueil"><svg class="icon icon-home">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-home"></use>
- </svg> Accueil</a> •
- <a href="https://github.com/dabeaz/dataklasses#questions-and-answers" title="Lien vers le contenu original">Source originale</a>
- </p>
- </nav>
- <hr>
- <p>Dataklasses is a library that allows you to quickly define data
- classes using Python type hints. Here's an example of how you use it:</p>
- <p>```python
- from dataklasses import dataklass</p>
- <p>@dataklass
- class Coordinates:
- x: int
- y: int
- ```</p>
- <p>The resulting class works in a well civilised way, providing the usual
- <code>__init__()</code>, <code>__repr__()</code>, and <code>__eq__()</code> methods that you'd normally
- have to type out by hand:</p>
- <p>```python</p>
- <blockquote>
- <blockquote>
- <blockquote>
- <p>a = Coordinates(2, 3)
- a
- Coordinates(2, 3)
- a.x
- 2
- a.y
- 3
- b = Coordinates(2, 3)
- a == b
- True</p>
- <p>```</p>
- </blockquote>
- </blockquote>
- </blockquote>
- <p>It's easy! Almost too easy.</p>
- <h2>Wait, doesn't this already exist?</h2>
- <p>No, it doesn't. Yes, certain naysayers will be quick to point out the
- existence of <code>@dataclass</code> from the standard library. Ok, sure, THAT
- exists. However, it's slow and complicated. Dataklasses are neither
- of those things. The entire <code>dataklasses</code> module is less than 100
- lines. The resulting classes import 15-20 times faster than
- dataclasses. See the <code>perf.py</code> file for a benchmark.</p>
- <h2>Theory of Operation</h2>
- <p>While out walking with his puppy, Dave had a certain insight about the nature
- of Python byte-code. Coming back to the house, he had to try it out:</p>
- <p>```python</p>
- <blockquote>
- <blockquote>
- <blockquote>
- <p>def <strong>init1</strong>(self, x, y):
- ... self.x = x
- ... self.y = y
- ...
- def <strong>init2</strong>(self, foo, bar):
- ... self.foo = foo
- ... self.bar = bar
- ...
- <strong>init1</strong>.<strong>code</strong>.co_code == <strong>init2</strong>.<strong>code</strong>.co_code
- True</p>
- <p>```</p>
- </blockquote>
- </blockquote>
- </blockquote>
- <p>How intriguing! The underlying byte-code is exactly the same even
- though the functions are using different argument and attribute names.
- Aha! Now, we're onto something interesting.</p>
- <p>The <code>dataclasses</code> module in the standard library works by collecting
- type hints, generating code strings, and executing them using the
- <code>exec()</code> function. This happens for every single class definition
- where it's used. If it sounds slow, that's because it is. In fact, it
- defeats any benefit of module caching in Python's import system.</p>
- <p>Dataklasses are different. They start out in the same manner--code is
- first generated by collecting type hints and using <code>exec()</code>. However,
- the underlying byte-code is cached and reused in subsequent class
- definitions whenever possible. Caching is good. </p>
- <h2>A Short Story</h2>
- <p>Once upon a time, there was this programming language that I'll refer
- to as "Lava." Anyways, anytime you started a program written in Lava,
- you could just tell by the awkward silence and inactivity of your
- machine before the fans kicked in. "Ah shit, this is written in Lava"
- you'd exclaim.</p>
- <h2>Questions and Answers</h2>
- <p><strong>Q: What methods does <code>dataklass</code> generate?</strong></p>
- <p>A: By default <code>__init__()</code>, <code>__repr__()</code>, and <code>__eq__()</code> methods are generated.
- <code>__match_args__</code> is also defined to assist with pattern matching.</p>
- <p><strong>Q: Does <code>dataklass</code> enforce the specified types?</strong></p>
- <p>A: No. The types are merely clues about what the value might be and
- the Python language does not provide any enforcement on its own. </p>
- <p><strong>Q: Are there any additional features?</strong></p>
- <p>A: No. You can either have features or you can have performance. Pick one.</p>
- <p><strong>Q: Does <code>dataklass</code> use any advanced magic such as metaclasses?</strong></p>
- <p>A: No. </p>
- <p><strong>Q: How do I install <code>dataklasses</code>?</strong></p>
- <p>A: There is no <code>setup.py</code> file, installer, or an official release. You
- install it by copying the code into your own project. <code>dataklasses.py</code> is
- small. You are encouraged to modify it to your own purposes.</p>
- <p><strong>Q: What versions of Python does it work with?</strong></p>
- <p>A: The code will work with versions 3.9 and later.</p>
- <p><strong>Q: But what if new features get added?</strong></p>
- <p>A: What new features? The best new features are no new features. </p>
- <p><strong>Q: Who maintains dataklasses?</strong></p>
- <p>A: If you're using it, you do. You maintain dataklasses.</p>
- <p><strong>Q: Is this actually a serious project?</strong></p>
- <p>A: It's best to think of dataklasses as more of an idea than a project.
- There are many tools and libraries that perform some form of code generation.
- Dataklasses is a proof-of-concept for a different approach to that. If you're
- a minimalist like me, you'll find it to be perfectly functional. If you're
- looking for a lot of knobs to turn, you should probably move along.</p>
- <p><strong>Q: Should I give dataklasses a GitHub star?</strong></p>
- <p>A: Yes, because it will help me look superior to the other parents with
- kids in the middle-school robot club.</p>
- <p><strong>Q: Who wrote this?</strong></p>
- <p>A: <code>dataklasses</code> is the work of David Beazley. http://www.dabeaz.com.</p>
- </article>
-
-
- <hr>
-
- <footer>
- <p>
- <a href="/david/" title="Aller à l’accueil"><svg class="icon icon-home">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-home"></use>
- </svg> Accueil</a> •
- <a href="/david/log/" title="Accès au flux RSS"><svg class="icon icon-rss2">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-rss2"></use>
- </svg> Suivre</a> •
- <a href="http://larlet.com" title="Go to my English profile" data-instant><svg class="icon icon-user-tie">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-user-tie"></use>
- </svg> Pro</a> •
- <a href="mailto:david%40larlet.fr" title="Envoyer un courriel"><svg class="icon icon-mail">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-mail"></use>
- </svg> Email</a> •
- <abbr class="nowrap" title="Hébergeur : Alwaysdata, 62 rue Tiquetonne 75002 Paris, +33184162340"><svg class="icon icon-hammer2">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-hammer2"></use>
- </svg> Légal</abbr>
- </p>
- <template id="theme-selector">
- <form>
- <fieldset>
- <legend><svg class="icon icon-brightness-contrast">
- <use xlink:href="/static/david/icons2/symbol-defs-2021-12.svg#icon-brightness-contrast"></use>
- </svg> Thème</legend>
- <label>
- <input type="radio" value="auto" name="chosen-color-scheme" checked> Auto
- </label>
- <label>
- <input type="radio" value="dark" name="chosen-color-scheme"> Foncé
- </label>
- <label>
- <input type="radio" value="light" name="chosen-color-scheme"> Clair
- </label>
- </fieldset>
- </form>
- </template>
- </footer>
- <script src="/static/david/js/instantpage-5.1.0.min.js" type="module"></script>
- <script>
- function loadThemeForm(templateName) {
- const themeSelectorTemplate = document.querySelector(templateName)
- const form = themeSelectorTemplate.content.firstElementChild
- themeSelectorTemplate.replaceWith(form)
-
- form.addEventListener('change', (e) => {
- const chosenColorScheme = e.target.value
- localStorage.setItem('theme', chosenColorScheme)
- toggleTheme(chosenColorScheme)
- })
-
- const selectedTheme = localStorage.getItem('theme')
- if (selectedTheme && selectedTheme !== 'undefined') {
- form.querySelector(`[value="${selectedTheme}"]`).checked = true
- }
- }
-
- const prefersColorSchemeDark = '(prefers-color-scheme: dark)'
- window.addEventListener('load', () => {
- let hasDarkRules = false
- for (const styleSheet of Array.from(document.styleSheets)) {
- let mediaRules = []
- for (const cssRule of styleSheet.cssRules) {
- if (cssRule.type !== CSSRule.MEDIA_RULE) {
- continue
- }
- // WARNING: Safari does not have/supports `conditionText`.
- if (cssRule.conditionText) {
- if (cssRule.conditionText !== prefersColorSchemeDark) {
- continue
- }
- } else {
- if (cssRule.cssText.startsWith(prefersColorSchemeDark)) {
- continue
- }
- }
- mediaRules = mediaRules.concat(Array.from(cssRule.cssRules))
- }
-
- // WARNING: do not try to insert a Rule to a styleSheet you are
- // currently iterating on, otherwise the browser will be stuck
- // in a infinite loop…
- for (const mediaRule of mediaRules) {
- styleSheet.insertRule(mediaRule.cssText)
- hasDarkRules = true
- }
- }
- if (hasDarkRules) {
- loadThemeForm('#theme-selector')
- }
- })
- </script>
- </body>
- </html>
|