hashcons 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
hashcons/__init__.py ADDED
@@ -0,0 +1,27 @@
1
+ """
2
+ Simple implementation of flyweight instance management using hash consing.
3
+ """
4
+
5
+ # HashCons: hash consing for flyweight classes
6
+ # Copyright (C) 2024 Hashberg Ltd
7
+
8
+ # This library is free software; you can redistribute it and/or
9
+ # modify it under the terms of the GNU Lesser General Public
10
+ # License as published by the Free Software Foundation; either
11
+ # version 2.1 of the License, or (at your option) any later version.
12
+
13
+ # This library is distributed in the hope that it will be useful,
14
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
15
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
+ # Lesser General Public License for more details.
17
+
18
+ # You should have received a copy of the GNU Lesser General Public
19
+ # License along with this library; if not, write to the Free Software
20
+ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
21
+ # USA
22
+
23
+ from .instance_store import InstanceStore
24
+
25
+ __all__ = (
26
+ "InstanceStore",
27
+ )
@@ -0,0 +1,226 @@
1
+ """
2
+ The :class:`InstanceStore` class provides a mechanism to manage the creation
3
+ of instances for flyweight classes, based on class and a unique instance key.
4
+ """
5
+
6
+ # Part of HashCons: hash consing for flyweight classes
7
+ # Copyright (C) 2024 Hashberg Ltd
8
+
9
+ # This library is free software; you can redistribute it and/or
10
+ # modify it under the terms of the GNU Lesser General Public
11
+ # License as published by the Free Software Foundation; either
12
+ # version 2.1 of the License, or (at your option) any later version.
13
+
14
+ # This library is distributed in the hope that it will be useful,
15
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
16
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
+ # Lesser General Public License for more details.
18
+
19
+ # You should have received a copy of the GNU Lesser General Public
20
+ # License along with this library; if not, write to the Free Software
21
+ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
22
+ # USA
23
+
24
+ from __future__ import annotations
25
+
26
+ from collections.abc import Hashable, Iterator
27
+ from contextlib import contextmanager
28
+ from threading import RLock
29
+ from typing import Any, ClassVar, Type, TypeVar, cast
30
+ from weakref import WeakValueDictionary
31
+ from typing_extensions import Self
32
+
33
+ T_co = TypeVar("T_co", covariant=True)
34
+ """
35
+ Covariant type variable for arbitrary values.
36
+ """
37
+
38
+ class InstanceStore:
39
+ """
40
+
41
+ An instance store, which can be used to manage the process of instance
42
+ creation for instances of flyweight classes.
43
+ Instances are stored internally in a :class:`~weakref.WeakValueDictionary`,
44
+ indexed by their class and a user-provided instance key.
45
+
46
+ The :meth:`instance` method implements a context manager for use within the
47
+ flyweight class constructor, within which managed instance creation can be
48
+ performed.
49
+
50
+ The :meth:`register` method must be called within the :meth:`instance`
51
+ context when a new instance is created, as opposed to when an existing
52
+ instance is used.
53
+
54
+ .. code-block:: python
55
+
56
+ class MyClass:
57
+
58
+ __store: ClassVar[InstanceStore] = InstanceStore()
59
+
60
+ def __new__(cls, ...) -> Self:
61
+ # args ^^^
62
+ key = ...# derive instance key from constructor args
63
+ with MyClass.__store.instance(cls, key) as self:
64
+ if self is None: # if no instance with given key exists
65
+ self = super().__new__(cls)
66
+ ... # <- set instance attributes here
67
+ MyClass.__store.register(self)
68
+ return self
69
+
70
+ ... # <- class body here
71
+
72
+ In order to customise the instance creation process, it will typically be
73
+ necessary to implement flyweight class constructors using
74
+ `__new__ <https://docs.python.org/3/reference/datamodel.html#object.__new__>`_,
75
+ rather than
76
+ `__init__ <https://docs.python.org/3/reference/datamodel.html#object.__init__>`_.
77
+
78
+ If `pickle <https://docs.python.org/3/library/pickle.html>` support is
79
+ desirable, flyweight classes should implement either the
80
+ `__getnewargs__ <https://docs.python.org/3/library/pickle.html#object.__getnewargs__>`_
81
+ method or the
82
+ `__getnewargs_ex__ <https://docs.python.org/3/library/pickle.html#object.__getnewargs_ex__>`_
83
+ method, depending on whether the constructor takes keyword-only arguments.
84
+ Classes should also implement
85
+ `__getstate__` <https://docs.python.org/3/library/pickle.html#object.__getstate__>`_
86
+ to return :obj:`None`, in order to prevent the default
87
+ `__setstate__` <https://docs.python.org/3/library/pickle.html#object.__setstate__>`_
88
+ being called by the pickling process (cf.
89
+ `PEP 307 <https://peps.python.org/pep-0307/#case-3-pickling-new-style-class-instances-using-protocol-2>`_).
90
+
91
+ .. code-block:: python
92
+
93
+ def __getnewargs__(self) -> tuple[...]:
94
+ # __new__ arg types here ^^^
95
+ return (...)
96
+ # ^^^ args to __new__ here
97
+
98
+ def __getstate__(self) -> Literal[None]:
99
+ return None
100
+
101
+ """
102
+ __lock: ClassVar[RLock] = RLock()
103
+
104
+ __instances: WeakValueDictionary[tuple[Type[Any], Hashable], Any]
105
+ __building_instance: bool
106
+ __instance_to_register: Any | None
107
+
108
+ __slots__ = (
109
+ "__weakref__",
110
+ "__instances",
111
+ "__building_instance",
112
+ "__instance_to_register",
113
+ )
114
+
115
+ def __new__(cls) -> Self:
116
+ store = super().__new__(cls)
117
+ store.__instances = WeakValueDictionary()
118
+ store.__building_instance = False
119
+ store.__instance_to_register = None
120
+ return store
121
+
122
+ def get(self, cls: Type[T_co], key: Hashable) -> T_co | None:
123
+ """
124
+ Returns the instance with given class and instance key,
125
+ or :obj:`None` if no such instance exists.
126
+ """
127
+ instance = self.__instances.get((cls, key))
128
+ return None if instance is None else cast(T_co, instance)
129
+
130
+ @contextmanager
131
+ def instance(self, cls: Type[T_co], key: Hashable) -> Iterator[T_co | None]:
132
+ """
133
+ Context manager to manage the creation of an instance of the given
134
+ class, uniquely identified by the given key.
135
+
136
+ If an instance with the given key already exists, it is yielded.
137
+ Otherwise, the following procedure is followed:
138
+
139
+ 1. The instance building process is started.
140
+ 2. The value :obj:`None` is yielded, to signal to the context
141
+ that no instance with the given key exists yet.
142
+ 3. Once control is returned to the context manager, it checks
143
+ that an instance was registered using the :meth`register` method,
144
+ and that it is actually an instance of the given class.
145
+ 4. If the checks from Step 3 are successful, the instance is stored
146
+ using the given class and key.
147
+ 5. Regardless of whether the checks from Step 3 are successful, the
148
+ instance building process is terminated.
149
+
150
+ It is possible for the same instance building process to be shared
151
+ by multiple contexts, e.g. when using the same store for instances
152
+ of a class and its subclasses.
153
+ If the context manager is invoked multiple times, it yields the
154
+ same value across all calls, but the instance process is started
155
+ at most once by the outermost call, and fully handled by it.
156
+ This makes it possible to create subclasses of a flyweight class.
157
+
158
+ If the instance building process is started, the
159
+ :meth:`~InstanceStore.register` method must be called exactly once.
160
+
161
+ Failure to comply with the above requirements results in an
162
+ :exc:`AssertionError` being raised.
163
+ For the sake of performance, all validation is done by assertions,
164
+ so it is removed when compiling with the
165
+ `-O flag <https://docs.python.org/3/using/cmdline.html#cmdoption-O>`_.
166
+
167
+ """
168
+ InstanceStore.__lock.acquire()
169
+ assert self.__instance_to_register is None, (
170
+ "Context manager 'instance' cannot be called after a managed "
171
+ "instance has already been created."
172
+ )
173
+ # Instance is already been built within another context, defer to it:
174
+ if self.__building_instance:
175
+ yield None
176
+ InstanceStore.__lock.release()
177
+ return
178
+ # If an instance with the given key already exists, return it:
179
+ existing_instance = cast(T_co, self.__instances.get((cls, key)))
180
+ if existing_instance is not None:
181
+ yield existing_instance
182
+ InstanceStore.__lock.release()
183
+ return
184
+ # Start the instance building process:
185
+ self.__building_instance = True
186
+ try:
187
+ # Signal that no instance exists:
188
+ yield None
189
+ # Ensure that an instance was actually constructed:
190
+ assert (instance := self.__instance_to_register) is not None, (
191
+ "Context manager signalled that no instance existed, "
192
+ "but a fresh instance was not constructed."
193
+ )
194
+ # Ensure that the instance is of the correct type:
195
+ assert isinstance(
196
+ instance, cls
197
+ ), f"Instance constructed is not of the expected type {cls!r}."
198
+ # If we get here, construction was successful and we must register:
199
+ self.__instances[(cls, key)] = instance
200
+ except BaseException as e:
201
+ # Unregister the instance if an error occurs after registration:
202
+ if (cls, key) in self.__instances:
203
+ del self.__instances[(cls, key)]
204
+ raise e
205
+ finally:
206
+ # Terminate the instance building process:
207
+ self.__building_instance = False
208
+ self.__instance_to_register = None
209
+ InstanceStore.__lock.release()
210
+
211
+ def register(self, instance: Any) -> None:
212
+ """
213
+ If the instance building process is active, the given instance
214
+ is registered as the fresh instance being built.
215
+ Otherwise, the instance is ignored.
216
+
217
+ If the instance building process is started by the :meth:`instance`
218
+ method, the :meth:`register` method must be called exactly once,
219
+ otherwise an :exc:`AssertionError` will be raised by the
220
+ :meth:`instance` method at the moment when the context is exited.
221
+ """
222
+ if self.__building_instance:
223
+ assert (
224
+ self.__instance_to_register is None
225
+ ), "Method 'register' can be called once per instance built."
226
+ self.__instance_to_register = instance
hashcons/py.typed ADDED
File without changes
@@ -0,0 +1,504 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 2.1, February 1999
3
+
4
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ [This is the first released version of the Lesser GPL. It also counts
10
+ as the successor of the GNU Library Public License, version 2, hence
11
+ the version number 2.1.]
12
+
13
+ Preamble
14
+
15
+ The licenses for most software are designed to take away your
16
+ freedom to share and change it. By contrast, the GNU General Public
17
+ Licenses are intended to guarantee your freedom to share and change
18
+ free software--to make sure the software is free for all its users.
19
+
20
+ This license, the Lesser General Public License, applies to some
21
+ specially designated software packages--typically libraries--of the
22
+ Free Software Foundation and other authors who decide to use it. You
23
+ can use it too, but we suggest you first think carefully about whether
24
+ this license or the ordinary General Public License is the better
25
+ strategy to use in any particular case, based on the explanations below.
26
+
27
+ When we speak of free software, we are referring to freedom of use,
28
+ not price. Our General Public Licenses are designed to make sure that
29
+ you have the freedom to distribute copies of free software (and charge
30
+ for this service if you wish); that you receive source code or can get
31
+ it if you want it; that you can change the software and use pieces of
32
+ it in new free programs; and that you are informed that you can do
33
+ these things.
34
+
35
+ To protect your rights, we need to make restrictions that forbid
36
+ distributors to deny you these rights or to ask you to surrender these
37
+ rights. These restrictions translate to certain responsibilities for
38
+ you if you distribute copies of the library or if you modify it.
39
+
40
+ For example, if you distribute copies of the library, whether gratis
41
+ or for a fee, you must give the recipients all the rights that we gave
42
+ you. You must make sure that they, too, receive or can get the source
43
+ code. If you link other code with the library, you must provide
44
+ complete object files to the recipients, so that they can relink them
45
+ with the library after making changes to the library and recompiling
46
+ it. And you must show them these terms so they know their rights.
47
+
48
+ We protect your rights with a two-step method: (1) we copyright the
49
+ library, and (2) we offer you this license, which gives you legal
50
+ permission to copy, distribute and/or modify the library.
51
+
52
+ To protect each distributor, we want to make it very clear that
53
+ there is no warranty for the free library. Also, if the library is
54
+ modified by someone else and passed on, the recipients should know
55
+ that what they have is not the original version, so that the original
56
+ author's reputation will not be affected by problems that might be
57
+ introduced by others.
58
+
59
+ Finally, software patents pose a constant threat to the existence of
60
+ any free program. We wish to make sure that a company cannot
61
+ effectively restrict the users of a free program by obtaining a
62
+ restrictive license from a patent holder. Therefore, we insist that
63
+ any patent license obtained for a version of the library must be
64
+ consistent with the full freedom of use specified in this license.
65
+
66
+ Most GNU software, including some libraries, is covered by the
67
+ ordinary GNU General Public License. This license, the GNU Lesser
68
+ General Public License, applies to certain designated libraries, and
69
+ is quite different from the ordinary General Public License. We use
70
+ this license for certain libraries in order to permit linking those
71
+ libraries into non-free programs.
72
+
73
+ When a program is linked with a library, whether statically or using
74
+ a shared library, the combination of the two is legally speaking a
75
+ combined work, a derivative of the original library. The ordinary
76
+ General Public License therefore permits such linking only if the
77
+ entire combination fits its criteria of freedom. The Lesser General
78
+ Public License permits more lax criteria for linking other code with
79
+ the library.
80
+
81
+ We call this license the "Lesser" General Public License because it
82
+ does Less to protect the user's freedom than the ordinary General
83
+ Public License. It also provides other free software developers Less
84
+ of an advantage over competing non-free programs. These disadvantages
85
+ are the reason we use the ordinary General Public License for many
86
+ libraries. However, the Lesser license provides advantages in certain
87
+ special circumstances.
88
+
89
+ For example, on rare occasions, there may be a special need to
90
+ encourage the widest possible use of a certain library, so that it becomes
91
+ a de-facto standard. To achieve this, non-free programs must be
92
+ allowed to use the library. A more frequent case is that a free
93
+ library does the same job as widely used non-free libraries. In this
94
+ case, there is little to gain by limiting the free library to free
95
+ software only, so we use the Lesser General Public License.
96
+
97
+ In other cases, permission to use a particular library in non-free
98
+ programs enables a greater number of people to use a large body of
99
+ free software. For example, permission to use the GNU C Library in
100
+ non-free programs enables many more people to use the whole GNU
101
+ operating system, as well as its variant, the GNU/Linux operating
102
+ system.
103
+
104
+ Although the Lesser General Public License is Less protective of the
105
+ users' freedom, it does ensure that the user of a program that is
106
+ linked with the Library has the freedom and the wherewithal to run
107
+ that program using a modified version of the Library.
108
+
109
+ The precise terms and conditions for copying, distribution and
110
+ modification follow. Pay close attention to the difference between a
111
+ "work based on the library" and a "work that uses the library". The
112
+ former contains code derived from the library, whereas the latter must
113
+ be combined with the library in order to run.
114
+
115
+ GNU LESSER GENERAL PUBLIC LICENSE
116
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117
+
118
+ 0. This License Agreement applies to any software library or other
119
+ program which contains a notice placed by the copyright holder or
120
+ other authorized party saying it may be distributed under the terms of
121
+ this Lesser General Public License (also called "this License").
122
+ Each licensee is addressed as "you".
123
+
124
+ A "library" means a collection of software functions and/or data
125
+ prepared so as to be conveniently linked with application programs
126
+ (which use some of those functions and data) to form executables.
127
+
128
+ The "Library", below, refers to any such software library or work
129
+ which has been distributed under these terms. A "work based on the
130
+ Library" means either the Library or any derivative work under
131
+ copyright law: that is to say, a work containing the Library or a
132
+ portion of it, either verbatim or with modifications and/or translated
133
+ straightforwardly into another language. (Hereinafter, translation is
134
+ included without limitation in the term "modification".)
135
+
136
+ "Source code" for a work means the preferred form of the work for
137
+ making modifications to it. For a library, complete source code means
138
+ all the source code for all modules it contains, plus any associated
139
+ interface definition files, plus the scripts used to control compilation
140
+ and installation of the library.
141
+
142
+ Activities other than copying, distribution and modification are not
143
+ covered by this License; they are outside its scope. The act of
144
+ running a program using the Library is not restricted, and output from
145
+ such a program is covered only if its contents constitute a work based
146
+ on the Library (independent of the use of the Library in a tool for
147
+ writing it). Whether that is true depends on what the Library does
148
+ and what the program that uses the Library does.
149
+
150
+ 1. You may copy and distribute verbatim copies of the Library's
151
+ complete source code as you receive it, in any medium, provided that
152
+ you conspicuously and appropriately publish on each copy an
153
+ appropriate copyright notice and disclaimer of warranty; keep intact
154
+ all the notices that refer to this License and to the absence of any
155
+ warranty; and distribute a copy of this License along with the
156
+ Library.
157
+
158
+ You may charge a fee for the physical act of transferring a copy,
159
+ and you may at your option offer warranty protection in exchange for a
160
+ fee.
161
+
162
+ 2. You may modify your copy or copies of the Library or any portion
163
+ of it, thus forming a work based on the Library, and copy and
164
+ distribute such modifications or work under the terms of Section 1
165
+ above, provided that you also meet all of these conditions:
166
+
167
+ a) The modified work must itself be a software library.
168
+
169
+ b) You must cause the files modified to carry prominent notices
170
+ stating that you changed the files and the date of any change.
171
+
172
+ c) You must cause the whole of the work to be licensed at no
173
+ charge to all third parties under the terms of this License.
174
+
175
+ d) If a facility in the modified Library refers to a function or a
176
+ table of data to be supplied by an application program that uses
177
+ the facility, other than as an argument passed when the facility
178
+ is invoked, then you must make a good faith effort to ensure that,
179
+ in the event an application does not supply such function or
180
+ table, the facility still operates, and performs whatever part of
181
+ its purpose remains meaningful.
182
+
183
+ (For example, a function in a library to compute square roots has
184
+ a purpose that is entirely well-defined independent of the
185
+ application. Therefore, Subsection 2d requires that any
186
+ application-supplied function or table used by this function must
187
+ be optional: if the application does not supply it, the square
188
+ root function must still compute square roots.)
189
+
190
+ These requirements apply to the modified work as a whole. If
191
+ identifiable sections of that work are not derived from the Library,
192
+ and can be reasonably considered independent and separate works in
193
+ themselves, then this License, and its terms, do not apply to those
194
+ sections when you distribute them as separate works. But when you
195
+ distribute the same sections as part of a whole which is a work based
196
+ on the Library, the distribution of the whole must be on the terms of
197
+ this License, whose permissions for other licensees extend to the
198
+ entire whole, and thus to each and every part regardless of who wrote
199
+ it.
200
+
201
+ Thus, it is not the intent of this section to claim rights or contest
202
+ your rights to work written entirely by you; rather, the intent is to
203
+ exercise the right to control the distribution of derivative or
204
+ collective works based on the Library.
205
+
206
+ In addition, mere aggregation of another work not based on the Library
207
+ with the Library (or with a work based on the Library) on a volume of
208
+ a storage or distribution medium does not bring the other work under
209
+ the scope of this License.
210
+
211
+ 3. You may opt to apply the terms of the ordinary GNU General Public
212
+ License instead of this License to a given copy of the Library. To do
213
+ this, you must alter all the notices that refer to this License, so
214
+ that they refer to the ordinary GNU General Public License, version 2,
215
+ instead of to this License. (If a newer version than version 2 of the
216
+ ordinary GNU General Public License has appeared, then you can specify
217
+ that version instead if you wish.) Do not make any other change in
218
+ these notices.
219
+
220
+ Once this change is made in a given copy, it is irreversible for
221
+ that copy, so the ordinary GNU General Public License applies to all
222
+ subsequent copies and derivative works made from that copy.
223
+
224
+ This option is useful when you wish to copy part of the code of
225
+ the Library into a program that is not a library.
226
+
227
+ 4. You may copy and distribute the Library (or a portion or
228
+ derivative of it, under Section 2) in object code or executable form
229
+ under the terms of Sections 1 and 2 above provided that you accompany
230
+ it with the complete corresponding machine-readable source code, which
231
+ must be distributed under the terms of Sections 1 and 2 above on a
232
+ medium customarily used for software interchange.
233
+
234
+ If distribution of object code is made by offering access to copy
235
+ from a designated place, then offering equivalent access to copy the
236
+ source code from the same place satisfies the requirement to
237
+ distribute the source code, even though third parties are not
238
+ compelled to copy the source along with the object code.
239
+
240
+ 5. A program that contains no derivative of any portion of the
241
+ Library, but is designed to work with the Library by being compiled or
242
+ linked with it, is called a "work that uses the Library". Such a
243
+ work, in isolation, is not a derivative work of the Library, and
244
+ therefore falls outside the scope of this License.
245
+
246
+ However, linking a "work that uses the Library" with the Library
247
+ creates an executable that is a derivative of the Library (because it
248
+ contains portions of the Library), rather than a "work that uses the
249
+ library". The executable is therefore covered by this License.
250
+ Section 6 states terms for distribution of such executables.
251
+
252
+ When a "work that uses the Library" uses material from a header file
253
+ that is part of the Library, the object code for the work may be a
254
+ derivative work of the Library even though the source code is not.
255
+ Whether this is true is especially significant if the work can be
256
+ linked without the Library, or if the work is itself a library. The
257
+ threshold for this to be true is not precisely defined by law.
258
+
259
+ If such an object file uses only numerical parameters, data
260
+ structure layouts and accessors, and small macros and small inline
261
+ functions (ten lines or less in length), then the use of the object
262
+ file is unrestricted, regardless of whether it is legally a derivative
263
+ work. (Executables containing this object code plus portions of the
264
+ Library will still fall under Section 6.)
265
+
266
+ Otherwise, if the work is a derivative of the Library, you may
267
+ distribute the object code for the work under the terms of Section 6.
268
+ Any executables containing that work also fall under Section 6,
269
+ whether or not they are linked directly with the Library itself.
270
+
271
+ 6. As an exception to the Sections above, you may also combine or
272
+ link a "work that uses the Library" with the Library to produce a
273
+ work containing portions of the Library, and distribute that work
274
+ under terms of your choice, provided that the terms permit
275
+ modification of the work for the customer's own use and reverse
276
+ engineering for debugging such modifications.
277
+
278
+ You must give prominent notice with each copy of the work that the
279
+ Library is used in it and that the Library and its use are covered by
280
+ this License. You must supply a copy of this License. If the work
281
+ during execution displays copyright notices, you must include the
282
+ copyright notice for the Library among them, as well as a reference
283
+ directing the user to the copy of this License. Also, you must do one
284
+ of these things:
285
+
286
+ a) Accompany the work with the complete corresponding
287
+ machine-readable source code for the Library including whatever
288
+ changes were used in the work (which must be distributed under
289
+ Sections 1 and 2 above); and, if the work is an executable linked
290
+ with the Library, with the complete machine-readable "work that
291
+ uses the Library", as object code and/or source code, so that the
292
+ user can modify the Library and then relink to produce a modified
293
+ executable containing the modified Library. (It is understood
294
+ that the user who changes the contents of definitions files in the
295
+ Library will not necessarily be able to recompile the application
296
+ to use the modified definitions.)
297
+
298
+ b) Use a suitable shared library mechanism for linking with the
299
+ Library. A suitable mechanism is one that (1) uses at run time a
300
+ copy of the library already present on the user's computer system,
301
+ rather than copying library functions into the executable, and (2)
302
+ will operate properly with a modified version of the library, if
303
+ the user installs one, as long as the modified version is
304
+ interface-compatible with the version that the work was made with.
305
+
306
+ c) Accompany the work with a written offer, valid for at
307
+ least three years, to give the same user the materials
308
+ specified in Subsection 6a, above, for a charge no more
309
+ than the cost of performing this distribution.
310
+
311
+ d) If distribution of the work is made by offering access to copy
312
+ from a designated place, offer equivalent access to copy the above
313
+ specified materials from the same place.
314
+
315
+ e) Verify that the user has already received a copy of these
316
+ materials or that you have already sent this user a copy.
317
+
318
+ For an executable, the required form of the "work that uses the
319
+ Library" must include any data and utility programs needed for
320
+ reproducing the executable from it. However, as a special exception,
321
+ the materials to be distributed need not include anything that is
322
+ normally distributed (in either source or binary form) with the major
323
+ components (compiler, kernel, and so on) of the operating system on
324
+ which the executable runs, unless that component itself accompanies
325
+ the executable.
326
+
327
+ It may happen that this requirement contradicts the license
328
+ restrictions of other proprietary libraries that do not normally
329
+ accompany the operating system. Such a contradiction means you cannot
330
+ use both them and the Library together in an executable that you
331
+ distribute.
332
+
333
+ 7. You may place library facilities that are a work based on the
334
+ Library side-by-side in a single library together with other library
335
+ facilities not covered by this License, and distribute such a combined
336
+ library, provided that the separate distribution of the work based on
337
+ the Library and of the other library facilities is otherwise
338
+ permitted, and provided that you do these two things:
339
+
340
+ a) Accompany the combined library with a copy of the same work
341
+ based on the Library, uncombined with any other library
342
+ facilities. This must be distributed under the terms of the
343
+ Sections above.
344
+
345
+ b) Give prominent notice with the combined library of the fact
346
+ that part of it is a work based on the Library, and explaining
347
+ where to find the accompanying uncombined form of the same work.
348
+
349
+ 8. You may not copy, modify, sublicense, link with, or distribute
350
+ the Library except as expressly provided under this License. Any
351
+ attempt otherwise to copy, modify, sublicense, link with, or
352
+ distribute the Library is void, and will automatically terminate your
353
+ rights under this License. However, parties who have received copies,
354
+ or rights, from you under this License will not have their licenses
355
+ terminated so long as such parties remain in full compliance.
356
+
357
+ 9. You are not required to accept this License, since you have not
358
+ signed it. However, nothing else grants you permission to modify or
359
+ distribute the Library or its derivative works. These actions are
360
+ prohibited by law if you do not accept this License. Therefore, by
361
+ modifying or distributing the Library (or any work based on the
362
+ Library), you indicate your acceptance of this License to do so, and
363
+ all its terms and conditions for copying, distributing or modifying
364
+ the Library or works based on it.
365
+
366
+ 10. Each time you redistribute the Library (or any work based on the
367
+ Library), the recipient automatically receives a license from the
368
+ original licensor to copy, distribute, link with or modify the Library
369
+ subject to these terms and conditions. You may not impose any further
370
+ restrictions on the recipients' exercise of the rights granted herein.
371
+ You are not responsible for enforcing compliance by third parties with
372
+ this License.
373
+
374
+ 11. If, as a consequence of a court judgment or allegation of patent
375
+ infringement or for any other reason (not limited to patent issues),
376
+ conditions are imposed on you (whether by court order, agreement or
377
+ otherwise) that contradict the conditions of this License, they do not
378
+ excuse you from the conditions of this License. If you cannot
379
+ distribute so as to satisfy simultaneously your obligations under this
380
+ License and any other pertinent obligations, then as a consequence you
381
+ may not distribute the Library at all. For example, if a patent
382
+ license would not permit royalty-free redistribution of the Library by
383
+ all those who receive copies directly or indirectly through you, then
384
+ the only way you could satisfy both it and this License would be to
385
+ refrain entirely from distribution of the Library.
386
+
387
+ If any portion of this section is held invalid or unenforceable under any
388
+ particular circumstance, the balance of the section is intended to apply,
389
+ and the section as a whole is intended to apply in other circumstances.
390
+
391
+ It is not the purpose of this section to induce you to infringe any
392
+ patents or other property right claims or to contest validity of any
393
+ such claims; this section has the sole purpose of protecting the
394
+ integrity of the free software distribution system which is
395
+ implemented by public license practices. Many people have made
396
+ generous contributions to the wide range of software distributed
397
+ through that system in reliance on consistent application of that
398
+ system; it is up to the author/donor to decide if he or she is willing
399
+ to distribute software through any other system and a licensee cannot
400
+ impose that choice.
401
+
402
+ This section is intended to make thoroughly clear what is believed to
403
+ be a consequence of the rest of this License.
404
+
405
+ 12. If the distribution and/or use of the Library is restricted in
406
+ certain countries either by patents or by copyrighted interfaces, the
407
+ original copyright holder who places the Library under this License may add
408
+ an explicit geographical distribution limitation excluding those countries,
409
+ so that distribution is permitted only in or among countries not thus
410
+ excluded. In such case, this License incorporates the limitation as if
411
+ written in the body of this License.
412
+
413
+ 13. The Free Software Foundation may publish revised and/or new
414
+ versions of the Lesser General Public License from time to time.
415
+ Such new versions will be similar in spirit to the present version,
416
+ but may differ in detail to address new problems or concerns.
417
+
418
+ Each version is given a distinguishing version number. If the Library
419
+ specifies a version number of this License which applies to it and
420
+ "any later version", you have the option of following the terms and
421
+ conditions either of that version or of any later version published by
422
+ the Free Software Foundation. If the Library does not specify a
423
+ license version number, you may choose any version ever published by
424
+ the Free Software Foundation.
425
+
426
+ 14. If you wish to incorporate parts of the Library into other free
427
+ programs whose distribution conditions are incompatible with these,
428
+ write to the author to ask for permission. For software which is
429
+ copyrighted by the Free Software Foundation, write to the Free
430
+ Software Foundation; we sometimes make exceptions for this. Our
431
+ decision will be guided by the two goals of preserving the free status
432
+ of all derivatives of our free software and of promoting the sharing
433
+ and reuse of software generally.
434
+
435
+ NO WARRANTY
436
+
437
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446
+
447
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456
+ DAMAGES.
457
+
458
+ END OF TERMS AND CONDITIONS
459
+
460
+ How to Apply These Terms to Your New Libraries
461
+
462
+ If you develop a new library, and you want it to be of the greatest
463
+ possible use to the public, we recommend making it free software that
464
+ everyone can redistribute and change. You can do so by permitting
465
+ redistribution under these terms (or, alternatively, under the terms of the
466
+ ordinary General Public License).
467
+
468
+ To apply these terms, attach the following notices to the library. It is
469
+ safest to attach them to the start of each source file to most effectively
470
+ convey the exclusion of warranty; and each file should have at least the
471
+ "copyright" line and a pointer to where the full notice is found.
472
+
473
+ <one line to give the library's name and a brief idea of what it does.>
474
+ Copyright (C) <year> <name of author>
475
+
476
+ This library is free software; you can redistribute it and/or
477
+ modify it under the terms of the GNU Lesser General Public
478
+ License as published by the Free Software Foundation; either
479
+ version 2.1 of the License, or (at your option) any later version.
480
+
481
+ This library is distributed in the hope that it will be useful,
482
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
483
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
484
+ Lesser General Public License for more details.
485
+
486
+ You should have received a copy of the GNU Lesser General Public
487
+ License along with this library; if not, write to the Free Software
488
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
489
+ USA
490
+
491
+ Also add information on how to contact you by electronic and paper mail.
492
+
493
+ You should also get your employer (if you work as a programmer) or your
494
+ school, if any, to sign a "copyright disclaimer" for the library, if
495
+ necessary. Here is a sample; alter the names:
496
+
497
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
498
+ library `Frob' (a library for tweaking knobs) written by James Random
499
+ Hacker.
500
+
501
+ <signature of Ty Coon>, 1 April 1990
502
+ Ty Coon, President of Vice
503
+
504
+ That's all there is to it!
@@ -0,0 +1,206 @@
1
+ Metadata-Version: 2.1
2
+ Name: hashcons
3
+ Version: 0.1.0
4
+ Summary: Hash consing for flyweight instance management.
5
+ Author: Hashberg
6
+ Project-URL: Documentation, https://hashcons.readthedocs.io
7
+ Project-URL: Repository, https://github.com/hashberg-io/hashcons
8
+ Project-URL: Issues, https://github.com/hashberg-io/hashcons/issues
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Programming Language :: Python :: 3.12
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Natural Language :: English
17
+ Classifier: Typing :: Typed
18
+ Requires-Python: >=3.9
19
+ Description-Content-Type: text/x-rst
20
+ License-File: LICENSE
21
+ Requires-Dist: typing-extensions>=4.12.2
22
+
23
+ hashcons: hash consing for flyweight classes
24
+ =============================================
25
+
26
+ .. image:: https://img.shields.io/badge/python-3.12+-green.svg
27
+ :target: https://docs.python.org/3.12/
28
+ :alt: Python versions
29
+
30
+ .. image:: https://img.shields.io/pypi/v/hashcons.svg
31
+ :target: https://pypi.python.org/pypi/hashcons/
32
+ :alt: PyPI version
33
+
34
+ .. image:: https://img.shields.io/pypi/status/hashcons.svg
35
+ :target: https://pypi.python.org/pypi/hashcons/
36
+ :alt: PyPI status
37
+
38
+ .. image:: http://www.mypy-lang.org/static/mypy_badge.svg
39
+ :target: https://github.com/python/mypy
40
+ :alt: Checked with Mypy
41
+
42
+ .. image:: https://readthedocs.org/projects/hashcons/badge/?version=latest
43
+ :target: https://hashcons.readthedocs.io/en/latest/?badge=latest
44
+ :alt: Documentation Status
45
+
46
+ .. image:: https://github.com/hashberg-io/hashcons/actions/workflows/python.yml/badge.svg
47
+ :target: https://github.com/hashberg-io/hashcons/actions/workflows/python.yml
48
+ :alt: Python package status
49
+
50
+ .. image:: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square
51
+ :target: https://github.com/RichardLitt/standard-readme
52
+ :alt: standard-readme compliant
53
+
54
+
55
+ A simple implementation of flyweight instance management using hash consing.
56
+
57
+ .. contents::
58
+
59
+ Install
60
+ -------
61
+
62
+ You can install the latest release from `PyPI <https://pypi.org/project/hashcons/>`_:
63
+
64
+ .. code-block:: console
65
+
66
+ $ pip install -U hashcons
67
+
68
+ Usage
69
+ -----
70
+
71
+ The `InstanceStore` class can be used to create instance stores, i.e. flyweight factories.
72
+ A common pattern is to use an instance store for each flyweight class, stored as a protected/private class attribute:
73
+
74
+ .. code-block:: python
75
+
76
+ from hashcons import InstanceStore
77
+ from typing import ClassVar
78
+ from typing_extensions import Self
79
+
80
+ class MyFrac:
81
+
82
+ _store: ClassVar[InstanceStore] = InstanceStore()
83
+
84
+ ... # <- class body here
85
+
86
+ In the constructor for the class, the store is queried by calling the `instance` method with:
87
+
88
+ - the specific subclass `cls`, because instances of different subclasses are stored separately;
89
+ - an `instance_key`, derived from the constructor arguments and uniquely identifying a flyweight instance.
90
+
91
+ The store returns the instance of the class for given instance key, or `None` if none exists.
92
+
93
+ .. code-block:: python
94
+
95
+ class MyFrac:
96
+
97
+ _store: ClassVar[InstanceStore] = InstanceStore()
98
+
99
+ def __new__(cls, num: int, den: int) -> Self:
100
+ instance_key = (num, den) # instance key derived from constructor args
101
+ with MyFrac._store.instance(cls, instance_key) as self:
102
+ if self is None:
103
+ ... # <- instance construction logic here
104
+ return self
105
+
106
+ ... # <- class body here
107
+
108
+ If no instance exists, one should be created, usually via a call to the super constructor.
109
+ When a new instance is created, its attributes should be validated and set.
110
+ The instance is then registered by passing it to the `register` method of the store.
111
+
112
+ .. code-block:: python
113
+
114
+ class MyFrac:
115
+
116
+ _store: ClassVar[InstanceStore] = InstanceStore()
117
+
118
+ __num: int
119
+ __den: int
120
+
121
+ def __new__(cls, num: int, den: int) -> Self:
122
+ instance_key = (num, den)
123
+ with MyFrac._store.instance(cls, instance_key) as self:
124
+ if self is None: # if no instance with given key exists
125
+ # 1. Validate constructor arguments:
126
+ if den == 0:
127
+ raise ZeroDivisionError()
128
+ # 2. Create the new instance:
129
+ self = super().__new__(cls)
130
+ # 3. Set instance attributes:
131
+ self.__num = num
132
+ self.__den = den
133
+ # 4. Register the instance in the store:
134
+ MyFrac._store.register(self)
135
+ return self
136
+
137
+ ... # <- class body here
138
+
139
+ Note that it is safe to raise exceptions as part of the instance construction process,
140
+ as the `instance` context manager will take care of performing the necessary cleanup.
141
+ The code snippet below exemplifies validation, new instance creation, and instance reuse.
142
+
143
+ .. code-block:: python
144
+
145
+ try:
146
+ inf = MyFrac(1, 0) # does not pass constructor validation
147
+ except ZeroDivisionError:
148
+ pass
149
+
150
+ x = MyFrac(10, 3) # new instance with key=(10, 3) created
151
+ x1 = MyFrac(10, 3) # instance with key=(10, 3) exists
152
+
153
+ assert x is x1 # a unique instance exists for each (cls, instance_key) pair
154
+
155
+ Because subclasses are stored separately, flyweight classes support inheritance.
156
+ Subclasses should use the `instance` context manager for the flyweight superclass's store, which will return an instance of the subclass for the given instance key, if one exists.
157
+ If a new instance of the subclass must be created, the subclass can do so by making a call to the superclass constructor:
158
+
159
+ 1. The `instance` context is entered in the superclass constructor:
160
+ it recognises that it is entered within another `instance` context for the same store,
161
+ it presumes that this is because the superclass constructor was called by a subclass, and it returns `None` to signal to the superclass constructor that a new instance is needed.
162
+ 2. The superclass constructor creates a new instance, sets its attributes, registers it,
163
+ and returns it to the subclass constructor.
164
+ 3. The subclass constructor takes the instance from the superclass constructor, sets its attribtues, and returns it.
165
+
166
+ Note that the subclass's constructor should not call `register` when creating a new instance:
167
+ by the time the superclass constructor returns, the new instance has already been registered.
168
+ The code snippet below exemplifies subclass usage.
169
+
170
+ .. code-block:: python
171
+
172
+ class MyNamedFrac(MyFrac):
173
+
174
+ __name: str
175
+
176
+ def __new__(cls, num: int, den: int, name: str) -> Self:
177
+ key = (num, den, name)
178
+ with MyFrac._store.instance(cls, key) as self:
179
+ if self is None:
180
+ self = super().__new__(cls, num, den)
181
+ self.__name = name
182
+ return self
183
+
184
+
185
+ y = MyNamedFrac(10, 3, "y") # new instance with key=(10, 3, 'y') created
186
+ y1 = MyNamedFrac(10, 3, "y") # instance with key=(10, 3, 'y') returned
187
+ z = MyNamedFrac(10, 3, "z") # new instance with key=(10, 3, 'z') created
188
+
189
+ assert y is not x
190
+ assert y is y1
191
+ assert y is not z
192
+
193
+ Subclasses can perform their validation both before and after the superclass constructor call.
194
+ The ability to perform validation after is important in cases where subclass validation depends on superclass validation, e.g. because it uses properties/methods of the partially initialised instance.
195
+ There is no issue with errors being raised after the superclass constructor has returned:
196
+ the new instance as been registered by the superclass constructor, but it will be unregistered by the subclass `instance` context if it is exited in error.
197
+
198
+ API
199
+ ---
200
+
201
+ The full API documentation is available at https://hashcons.readthedocs.io/
202
+
203
+ License
204
+ -------
205
+
206
+ `LGPL © Hashberg Ltd. <LICENSE>`_
@@ -0,0 +1,8 @@
1
+ hashcons/__init__.py,sha256=XSjIjr2l3thgHEiXpQw-d4yPKJej43bpDKAj1feKcGU,971
2
+ hashcons/instance_store.py,sha256=9jq9bmAnYhHqdDIhiIcjAdEysIzIIMZQ_6kHJXA8a2s,9840
3
+ hashcons/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
+ hashcons-0.1.0.dist-info/LICENSE,sha256=f_4ZVFh8d9-6HPjrmy6nQ2cfpuY_nnovJYEZ1C4U7v4,27030
5
+ hashcons-0.1.0.dist-info/METADATA,sha256=Ujmz3NIaR9YIDe0TFSRmRIk6IfGOo6Z33l8JijZATiI,8222
6
+ hashcons-0.1.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
7
+ hashcons-0.1.0.dist-info/top_level.txt,sha256=ilE_LkkLRWnrhSP3acbGrDk08eZifOUx7hcgDjthex4,9
8
+ hashcons-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.1.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ hashcons