coolabah 0.1.0__tar.gz

coolabah-0.1.0/LICENSE.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

coolabah-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: coolabah
+Version: 0.1.0
+Summary: Generate and assemble file trees using Python generators.
+Author: Jahin Z.
+Author-email: Jahin Z. <git@jahinzee.net>
+License-Expression: MPL-2.0
+License-File: LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Topic :: System :: Filesystems
+Classifier: Typing :: Typed
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Project-URL: Homepage, https://codeberg.org/jahinzee/coolabah
+Project-URL: Issues, https://codeberg.org/jahinzee/coolabah/issues
+Description-Content-Type: text/markdown
+
+# Coolabah
+
+[![Coolabah](https://img.shields.io/badge/Coolabah-873cee?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyNCAxNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxIDEpIj4KICAgIDxnPgogICAgICA8cGF0aCBkPSJNMCA4QzAgMy41ODE3MiAzLjU4MTcyIDAgOCAwQzEyLjQxODMgMCAxNiAzLjU4MTcyIDE2IDgiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDIgMCkiIC8%2BCiAgICAgIDxwYXRoIGQ9Ik0wIDRDMCAxLjc5MDg2IDEuNzkwODYgMCA0IDBDNi4yMDkxNCAwIDggMS43OTA4NiA4IDQiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0ibWF0cml4KDEgMCAwIC0xIDEwIDEyKSIgLz4KICAgICAgPHBhdGggZD0iTTAgMy45NTkzNUwxMiA0TDEyIDAiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEwIDQpIiAvPgogICAgICA8cGF0aCBkPSJNMCAyQzAgMC44OTU0MzEgMC44OTU0MyAwIDIgMEMzLjEwNDU3IDAgNCAwLjg5NTQzMSA0IDJDNCAzLjEwNDU3IDMuMTA0NTcgNCAyIDRDMC44OTU0MyA0IDAgMy4xMDQ1NyAwIDJaIiBmaWxsPSJub25lIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZT0iI0ZGRkZGRiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwIDgpIiAvPgogICAgPC9nPgogIDwvZz4KPC9zdmc%2B)](https://codeberg.org/jahinzee/coolabah)
+[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
+[![brainmade.org](https://img.shields.io/badge/brainmade.org-000000?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iNzkiIHZpZXdCb3g9IjAgMCA2NyA3OSIgZmlsbD0ibm9uZSI%2BPHBhdGggZmlsbD0iI2ZmZiIgZD0iTTUyLjYxMiA3OC43ODJIMjMuMzNhMi41NTkgMi41NTkgMCAwIDEtMi41Ni0yLjU1OHYtNy42NzdoLTcuOTczYTIuNTYgMi41NiAwIDAgMS0yLjU2LTIuNTZWNTUuMzE1bC04LjgyLTQuMzk3YTIuNTU5IDIuNTU5IDAgMCAxLS45ODYtMy43MWw5LjgwNy0xNC43MTR2LTQuMzVDMTAuMjQgMTIuNTk5IDIyLjg0MyAwIDM4LjM4OCAwIDUzLjkzMiAwIDY2LjUzNCAxMi42IDY2LjUzOCAyOC4xNDNjLS42MzIgMjcuODI0LTEwLjc2IDIzLjUxNi0xMS4xOCAzNC4wNDVsLS4xODcgMTQuMDM1YTIuNTkgMi41OSAwIDAgMS0uNzUgMS44MSAyLjU1IDIuNTUgMCAwIDEtMS44MDkuNzVabS0yNi43MjMtNS4xMTdoMjQuMTY0bC4yODYtMTQuNTQyYy0uMjYzLTYuNjU2IDExLjcxNi04LjI0MyAxMS4wOC0zMC43MzQtLjM1OC0xMi43MTMtMTAuMzEzLTIzLjI3MS0yMy4wMzEtMjMuMjcxLTEyLjcxOCAwLTIzLjAyOSAxMC4zMDctMjMuMDMyIDIzLjAyNXY1LjExN2MwIC41MDYtLjE1IDEtLjQzIDEuNDJsLTguNjMgMTIuOTQxIDcuNjQ1IDMuODJhMi41NTkgMi41NTkgMCAwIDEgMS40MTUgMi4yOTF2OS42OTdoNy45NzRhMi41NTkgMi41NTkgMCAwIDEgMi41NiAyLjU1OXY3LjY3N1oiLz48cGF0aCBmaWxsPSIjZmZmIiBkPSJNNDAuMzcyIDU4LjIyMlYzOC45MzRjLjExOCAwIC4yMzcuMDE4LjM1NS4wMTggOS43NjktLjAxMiAxNy4wNS05LjAxMiAxNS4wMjItMTguNTY3YTIuMzY2IDIuMzY2IDAgMCAwLTEuODIxLTEuODIyYy04LjEwNi0xLjczLTE2LjEyMSAzLjI5Mi0xOC4wOTggMTEuMzQxLS4wMjQtLjAyNC0uMDQzLS4wNS0uMDY2LS4wNzNhMTUuMzIzIDE1LjMyMyAwIDAgMC0xNC4wNi00LjE3IDIuMzY1IDIuMzY1IDAgMCAwLTEuODIxIDEuODJjLTIuMDI4IDkuNTU1IDUuMjUyIDE4LjU1NCAxNS4wMiAxOC41NjguMjM2IDAgLjQ5Mi0uMDI4LjczOC0uMDR2MTIuMjEzaDQuNzMxWm0yLjgzOS0zMi4xNDNhMTAuNjQ2IDEwLjY0NiAwIDAgMSA4LjEyNC0zLjEwNmMuMzUgNi4zNC00Ljg4OCAxMS41NzctMTEuMjI4IDExLjIzYTEwLjU4IDEwLjU4IDAgMCAxIDMuMTA0LTguMTI0Wk0yNy40MDMgMzguMTkzYTEwLjYwNyAxMC42MDcgMCAwIDEtMy4xMTgtOC4xMjNjNi4zNDQtLjM1OCAxMS41ODcgNC44ODYgMTEuMjI4IDExLjIzLTMuMDIzLjE2OS01Ljk3My0uOTYxLTguMTEtMy4xMDdaIi8%2BPC9zdmc%2B)](https://brainmade.org/)
+
+Generate and assemble file trees using Python generators.
+
+- Composable and easy-to-use interface.
+- Smart directory writing, only updates files between if necessary, and cleans unknown files.
+- Supports parallel file generation.
+- No third-party dependencies.
+
+To get started, see the [Handbook](docs/handbook.md).
+
+```py
+from coolabah import directory, text_file, assemble
+
+@directory
+def root():
+    yield "foo.txt", text_file("Hello, World!")
+    yield "baz.txt", text_file("Ave, munde!")
+    yield "bar.txt", text_file("こんにちは、世界！")
+
+if __name__ == "__main__":
+    assemble(root(), destination="serve/")
+```
+
+```
+$ python ./fruit_shop.py
+...
+[Info] Tree generation complete.
+$ tree serve
+serve/
+├── foo.txt
+├── bar.txt
+└── baz.txt
+
+1 directory, 3 files
+
+$ cat serve/*.txt
+Hello, World!
+Ave, munde!
+こんにちは、世界！
+```
+
+
+## License and Acknowledgements
+
+Coolabah is [open-source software][osd], and is licensed under the
+[Mozilla Public License, v. 2.0.][mplv2.0].
+
+[osd]: https://opensource.org/osd
+[mplv2.0]: https://www.mozilla.org/en-US/MPL/2.0/
+
+The [Coolabah logos](docs/coolabah.svg) are available under 
+[Creative Commons Attribution-ShareAlike 4.0 International][cc-by-sa-4.0].
+
+[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
+
+Coolabah is a [Brainmade] project, no generative AI tools were used during development.
+
+[Brainmade]: https://brainmade.org/

coolabah-0.1.0/README.md

@@ -0,0 +1,63 @@
+# Coolabah
+
+[![Coolabah](https://img.shields.io/badge/Coolabah-873cee?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyNCAxNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxIDEpIj4KICAgIDxnPgogICAgICA8cGF0aCBkPSJNMCA4QzAgMy41ODE3MiAzLjU4MTcyIDAgOCAwQzEyLjQxODMgMCAxNiAzLjU4MTcyIDE2IDgiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDIgMCkiIC8%2BCiAgICAgIDxwYXRoIGQ9Ik0wIDRDMCAxLjc5MDg2IDEuNzkwODYgMCA0IDBDNi4yMDkxNCAwIDggMS43OTA4NiA4IDQiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0ibWF0cml4KDEgMCAwIC0xIDEwIDEyKSIgLz4KICAgICAgPHBhdGggZD0iTTAgMy45NTkzNUwxMiA0TDEyIDAiIGZpbGw9Im5vbmUiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlPSIjRkZGRkZGIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDEwIDQpIiAvPgogICAgICA8cGF0aCBkPSJNMCAyQzAgMC44OTU0MzEgMC44OTU0MyAwIDIgMEMzLjEwNDU3IDAgNCAwLjg5NTQzMSA0IDJDNCAzLjEwNDU3IDMuMTA0NTcgNCAyIDRDMC44OTU0MyA0IDAgMy4xMDQ1NyAwIDJaIiBmaWxsPSJub25lIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZT0iI0ZGRkZGRiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwIDgpIiAvPgogICAgPC9nPgogIDwvZz4KPC9zdmc%2B)](https://codeberg.org/jahinzee/coolabah)
+[![License: MPL 2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
+[![brainmade.org](https://img.shields.io/badge/brainmade.org-000000?style=flat&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxZW0iIGhlaWdodD0iNzkiIHZpZXdCb3g9IjAgMCA2NyA3OSIgZmlsbD0ibm9uZSI%2BPHBhdGggZmlsbD0iI2ZmZiIgZD0iTTUyLjYxMiA3OC43ODJIMjMuMzNhMi41NTkgMi41NTkgMCAwIDEtMi41Ni0yLjU1OHYtNy42NzdoLTcuOTczYTIuNTYgMi41NiAwIDAgMS0yLjU2LTIuNTZWNTUuMzE1bC04LjgyLTQuMzk3YTIuNTU5IDIuNTU5IDAgMCAxLS45ODYtMy43MWw5LjgwNy0xNC43MTR2LTQuMzVDMTAuMjQgMTIuNTk5IDIyLjg0MyAwIDM4LjM4OCAwIDUzLjkzMiAwIDY2LjUzNCAxMi42IDY2LjUzOCAyOC4xNDNjLS42MzIgMjcuODI0LTEwLjc2IDIzLjUxNi0xMS4xOCAzNC4wNDVsLS4xODcgMTQuMDM1YTIuNTkgMi41OSAwIDAgMS0uNzUgMS44MSAyLjU1IDIuNTUgMCAwIDEtMS44MDkuNzVabS0yNi43MjMtNS4xMTdoMjQuMTY0bC4yODYtMTQuNTQyYy0uMjYzLTYuNjU2IDExLjcxNi04LjI0MyAxMS4wOC0zMC43MzQtLjM1OC0xMi43MTMtMTAuMzEzLTIzLjI3MS0yMy4wMzEtMjMuMjcxLTEyLjcxOCAwLTIzLjAyOSAxMC4zMDctMjMuMDMyIDIzLjAyNXY1LjExN2MwIC41MDYtLjE1IDEtLjQzIDEuNDJsLTguNjMgMTIuOTQxIDcuNjQ1IDMuODJhMi41NTkgMi41NTkgMCAwIDEgMS40MTUgMi4yOTF2OS42OTdoNy45NzRhMi41NTkgMi41NTkgMCAwIDEgMi41NiAyLjU1OXY3LjY3N1oiLz48cGF0aCBmaWxsPSIjZmZmIiBkPSJNNDAuMzcyIDU4LjIyMlYzOC45MzRjLjExOCAwIC4yMzcuMDE4LjM1NS4wMTggOS43NjktLjAxMiAxNy4wNS05LjAxMiAxNS4wMjItMTguNTY3YTIuMzY2IDIuMzY2IDAgMCAwLTEuODIxLTEuODIyYy04LjEwNi0xLjczLTE2LjEyMSAzLjI5Mi0xOC4wOTggMTEuMzQxLS4wMjQtLjAyNC0uMDQzLS4wNS0uMDY2LS4wNzNhMTUuMzIzIDE1LjMyMyAwIDAgMC0xNC4wNi00LjE3IDIuMzY1IDIuMzY1IDAgMCAwLTEuODIxIDEuODJjLTIuMDI4IDkuNTU1IDUuMjUyIDE4LjU1NCAxNS4wMiAxOC41NjguMjM2IDAgLjQ5Mi0uMDI4LjczOC0uMDR2MTIuMjEzaDQuNzMxWm0yLjgzOS0zMi4xNDNhMTAuNjQ2IDEwLjY0NiAwIDAgMSA4LjEyNC0zLjEwNmMuMzUgNi4zNC00Ljg4OCAxMS41NzctMTEuMjI4IDExLjIzYTEwLjU4IDEwLjU4IDAgMCAxIDMuMTA0LTguMTI0Wk0yNy40MDMgMzguMTkzYTEwLjYwNyAxMC42MDcgMCAwIDEtMy4xMTgtOC4xMjNjNi4zNDQtLjM1OCAxMS41ODcgNC44ODYgMTEuMjI4IDExLjIzLTMuMDIzLjE2OS01Ljk3My0uOTYxLTguMTEtMy4xMDdaIi8%2BPC9zdmc%2B)](https://brainmade.org/)
+
+Generate and assemble file trees using Python generators.
+
+- Composable and easy-to-use interface.
+- Smart directory writing, only updates files between if necessary, and cleans unknown files.
+- Supports parallel file generation.
+- No third-party dependencies.
+
+To get started, see the [Handbook](docs/handbook.md).
+
+```py
+from coolabah import directory, text_file, assemble
+
+@directory
+def root():
+    yield "foo.txt", text_file("Hello, World!")
+    yield "baz.txt", text_file("Ave, munde!")
+    yield "bar.txt", text_file("こんにちは、世界！")
+
+if __name__ == "__main__":
+    assemble(root(), destination="serve/")
+```
+
+```
+$ python ./fruit_shop.py
+...
+[Info] Tree generation complete.
+$ tree serve
+serve/
+├── foo.txt
+├── bar.txt
+└── baz.txt
+
+1 directory, 3 files
+
+$ cat serve/*.txt
+Hello, World!
+Ave, munde!
+こんにちは、世界！
+```
+
+
+## License and Acknowledgements
+
+Coolabah is [open-source software][osd], and is licensed under the
+[Mozilla Public License, v. 2.0.][mplv2.0].
+
+[osd]: https://opensource.org/osd
+[mplv2.0]: https://www.mozilla.org/en-US/MPL/2.0/
+
+The [Coolabah logos](docs/coolabah.svg) are available under 
+[Creative Commons Attribution-ShareAlike 4.0 International][cc-by-sa-4.0].
+
+[cc-by-sa-4.0]: https://creativecommons.org/licenses/by-sa/4.0/
+
+Coolabah is a [Brainmade] project, no generative AI tools were used during development.
+
+[Brainmade]: https://brainmade.org/

coolabah-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "coolabah"
+version = "0.1.0"
+description = "Generate and assemble file trees using Python generators."
+readme = "README.md"
+license = "MPL-2.0"
+license-files = ["LICENSE.txt"]
+requires-python = ">=3.12"
+dependencies = []
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Topic :: System :: Filesystems",
+    "Typing :: Typed",
+    "Operating System :: OS Independent",
+]
+
+[[project.authors]]
+name = "Jahin Z."
+email = "git@jahinzee.net"
+
+[project.urls]
+Homepage = "https://codeberg.org/jahinzee/coolabah"
+Issues = "https://codeberg.org/jahinzee/coolabah/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 100

coolabah-0.1.0/pyproject.toml.orig

@@ -0,0 +1,28 @@
+[project]
+name = "coolabah"
+version = "0.1.0"
+description = "Generate and assemble file trees using Python generators."
+readme = "README.md"
+license = "MPL-2.0"
+license-files = ["LICENSE.txt"]
+authors = [{ name = "Jahin Z.", email = "git@jahinzee.net" }]
+requires-python = ">=3.12"
+dependencies = []
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Topic :: System :: Filesystems",
+    "Typing :: Typed",
+    "Operating System :: OS Independent",
+]
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 100
+
+[project.urls]
+Homepage = "https://codeberg.org/jahinzee/coolabah"
+Issues = "https://codeberg.org/jahinzee/coolabah/issues"

coolabah-0.1.0/src/coolabah/__init__.py

@@ -0,0 +1,28 @@
+# coolabah -- basic exports.
+#
+# Author: Jahin Z. <git@jahinzee.net>
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+
+from coolabah.assembler import assemble
+from coolabah.nodes import (
+    copy_file,
+    directory,
+    iterable_directory,
+    json_file,
+    mapping_directory,
+    text_file,
+)
+
+__all__ = (
+    "assemble",
+    "copy_file",
+    "directory",
+    "iterable_directory",
+    "json_file",
+    "mapping_directory",
+    "text_file",
+)

coolabah-0.1.0/src/coolabah/_io.py

@@ -0,0 +1,93 @@
+# coolabah -- Internal submodule for status logging.
+#
+# Author: Jahin Z. <git@jahinzee.net>
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+
+__package__ = "coolabah"
+
+import os
+import platform
+import sys
+from enum import Enum
+
+
+def _eprint(*msg: object, sep: str = " "):
+    print(*msg, file=sys.stderr, sep=sep)
+
+
+class _Colour(Enum):
+    Reset = "0"
+    Red = "0;31"
+    Green = "0;32"
+    Yellow = "0;33"
+    Blue = "0;34"
+    Grey = "0;37"
+
+    @staticmethod
+    def _colour_allowed() -> bool:
+        return all(
+            (
+                sys.stdout.isatty(),
+                platform.system() != "Windows",
+                os.environ.get("NO_COLOR") != "1",
+            )
+        )
+
+    def __str__(self) -> str:
+        return f"\033[{self.value}m" if self._colour_allowed() else ""
+
+    def fmt(self, s: str, /) -> str:
+        return f"{self!s}{s}{_Colour.Reset!s}"
+
+
+class Status(Enum):
+    Created = ("Created", _Colour.Green)
+    Updated = ("Updated", _Colour.Green)
+    Skipped = ("Skipped", _Colour.Grey)
+    Failed = ("Failed", _Colour.Red)
+    Removed = ("Removed", _Colour.Yellow)
+    Warning = ("Warning", _Colour.Yellow)
+    Error = ("Error", _Colour.Red)
+    Info = ("Info", _Colour.Blue)
+
+    @property
+    def emblem(self) -> str:
+        label, colour = self.value
+        return colour.fmt(f"[{label}]")
+
+    @property
+    def emblem_continue(self) -> str:
+        label, colour = self.value
+        return colour.fmt(f"{'..':>{len(label) + 2}}")
+
+    def eprint(self, msg: object, *more: object):
+        _eprint(self.emblem, str(msg))
+        for m in more:
+            _eprint(self.emblem_continue, str(m))
+
+
+def fmt_exception(exc: BaseException | None) -> str:
+    return f"{type(exc).__name__}: {exc!s}" if exc is not None else ""
+
+
+def log_warning(msg: object, *more: object):
+    Status.Warning.eprint(msg, *more)
+
+
+def log_fatal_error(msg: object, *more: object):
+    Status.Error.eprint(msg, *more)
+    sys.exit(1)
+
+
+def make_logger(log: bool, status: Status):
+    # fmt: off
+    if log:
+        def _log(*msg: object): status.eprint(*msg)
+    else:
+        def _log(*_msg: object): pass
+    # fmt: on
+    return _log

coolabah-0.1.0/src/coolabah/assembler.py

@@ -0,0 +1,185 @@
+# coolabah -- The assembler and helper functions.
+#
+# Author: Jahin Z. <git@jahinzee.net>
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+
+from __future__ import annotations
+
+__package__ = "coolabah"
+
+import enum
+from multiprocessing.pool import Pool
+from pathlib import Path
+from typing import NamedTuple
+
+from coolabah._io import Status, fmt_exception, log_fatal_error, log_warning, make_logger
+from coolabah.nodes import Directory
+from coolabah.types import File, PopulationError, StrPath
+
+
+class _ProcessResultStatus(enum.Enum):
+    SUCCESS_SKIP = enum.auto()
+    SUCCESS_CREATE = enum.auto()
+    SUCCESS_UPDATE = enum.auto()
+    FAIL_WARN = enum.auto()
+    FAIL_FATAL = enum.auto()
+
+    @property
+    def success(self) -> bool:
+        return self not in {self.FAIL_WARN, self.FAIL_FATAL}
+
+
+class _ProcessResult(NamedTuple):
+    status: _ProcessResultStatus
+    path: Path
+    exc: BaseException | None
+
+
+def _process_file(path_and_file: tuple[Path, File]) -> _ProcessResult:
+    path, file = path_and_file
+
+    if path.exists() and not file.differs(path):
+        return _ProcessResult(_ProcessResultStatus.SUCCESS_SKIP, path, None)
+
+    update = path.exists()
+    path.unlink(missing_ok=True)
+    path.parent.mkdir(parents=True, exist_ok=True)
+    try:
+        try:
+            file.populate(path)
+        except PopulationError as pe:
+            if not pe.fatal:
+                return _ProcessResult(_ProcessResultStatus.FAIL_WARN, path, pe)
+            raise
+    except Exception as e:
+        return _ProcessResult(_ProcessResultStatus.FAIL_FATAL, path, e)
+        raise
+
+    return _ProcessResult(
+        _ProcessResultStatus.SUCCESS_UPDATE if update else _ProcessResultStatus.SUCCESS_CREATE,
+        path,
+        None,
+    )
+
+
+# ---
+
+
+def assemble(
+    directory: Directory,
+    *,
+    destination: StrPath,
+    clean: bool = True,
+    clobber_ok: bool = False,
+    log: bool = True,
+    log_skips: bool = True,
+    jobs: int | None = None,
+):
+    """
+    Assembles a directory into a destination.
+
+    ## Keyword arguments
+
+    ### `destination` (`str | Path`, required)
+    The destination path to create the file tree.
+
+    ### `clean` (`bool`, default: `True`)
+    If `True`, removes any unsuccessful or unknown files and directories after generation.
+
+    ### `clobber_ok`: (`bool`, default: `False`)
+    If `True`, only shows a warning if multiple files are mapped to the same path. If `False`,
+    assembly halts before file generation.
+
+    ### `log`: (`bool`, default: `True`)
+    If `True`, Logs info and file operation statuses to standard error. Note that warnings and
+    errors are always logged.
+
+    ### `log_skips`: (`bool`, default: `True`)
+    If `False`, do not log skipped files, even if `log` is `True`.
+
+    ### `jobs`: (`int`, optional)
+    If not `None`, uses a subprocess pool with the given number of processes for file population.
+    Uses the main processs if `None`. Note that clean operations (if `clean` is `True`) do not use
+    subprocesses.
+    """
+
+    log_info = make_logger(log, Status.Info)
+    log_created = make_logger(log, Status.Created)
+    log_removed = make_logger(log, Status.Removed)
+    log_updated = make_logger(log, Status.Updated)
+    log_skipped = make_logger(log, Status.Skipped)
+
+    def collect_and_count(root, dir):
+        paths, counts = {}, {}
+        for p, f in dir.enumerate_eager():
+            paths[root / p] = f
+            counts[p] = counts.get(p, 0) + 1
+
+        return paths, counts
+
+    def directory_is_empty(path) -> bool:
+        return path.is_dir() and next(path.iterdir(), None) is None
+
+    def clean_root(keep):
+        existing = {f for f in Path(destination).glob("**/*") if not f.is_dir()}
+        to_delete = existing - keep
+        for path in to_delete:
+            path.unlink()
+            log_removed(path)
+
+        while empty_dirs := set(filter(directory_is_empty, Path(destination).glob("**/*"))):
+            for dir in empty_dirs:
+                dir.rmdir()
+                log_removed(path)
+
+    def get_results():
+        if jobs is None:
+            yield from (_process_file(pi) for pi in paths.items())
+            return
+        log_info(f"Processing files using {jobs} subprocess(es).")
+        with Pool(processes=jobs) as pool:
+            yield from pool.imap_unordered(_process_file, paths.items())
+
+    # ---
+
+    paths, counts = collect_and_count(destination, directory)
+
+    log_info(f"Collected {len(paths)} file object(s).")
+    for path, count in counts.items():
+        if count <= 1:
+            continue
+        message = f"{destination / path}: Path was yielded {count} times, paths may be clobbered."
+        if clobber_ok:
+            log_warning(message, "Using latest file object, continuing...")
+        else:
+            log_fatal_error(message)
+
+    successful_paths = set()
+
+    for r in get_results():
+        if r.status.success:
+            successful_paths.add(r.path)
+        match r.status:
+            case _ProcessResultStatus.SUCCESS_CREATE:
+                log_created(r.path)
+            case _ProcessResultStatus.SUCCESS_UPDATE:
+                log_updated(r.path)
+            case _ProcessResultStatus.SUCCESS_SKIP:
+                log_skipped(r.path)
+            case _ProcessResultStatus.FAIL_WARN:
+                log_warning(f"{r.path}: Non-fatal exception", fmt_exception(r.exc))
+            case _ProcessResultStatus.FAIL_FATAL:
+                log_fatal_error(
+                    f"{r.path}: Fatal exception",
+                    fmt_exception(r.exc),
+                    f"{destination}: destination may be in an inconsistent state",
+                )
+    if clean:
+        log_info("Cleaning unknown or unsuccessful files...")
+        clean_root(keep=successful_paths)
+
+    log_info("Tree generation complete.")

coolabah-0.1.0/src/coolabah/nodes.py

@@ -0,0 +1,226 @@
+# coolabah -- Basic file and folder types.
+#
+# Author: Jahin Z. <git@jahinzee.net>
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+
+__package__ = "coolabah"
+
+import dataclasses
+import filecmp
+import io
+import json
+import shutil
+from collections.abc import Iterable, Mapping
+from io import StringIO
+from itertools import zip_longest
+from pathlib import Path
+from typing import TYPE_CHECKING, Never, ParamSpec
+
+if TYPE_CHECKING: from _typeshed import SupportsRead  # noqa: I001 # fmt: skip
+
+from coolabah.types import Directory, DirectoryCallable, File, Node, PopulationError, StrPath
+
+P = ParamSpec("P")
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _EmptyFile(File):
+    def populate(self, path: Path):
+        path.touch()
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _CopyFile(File):
+    _source: Path
+
+    def populate(self, path):
+        shutil.copy(self._source, path)
+
+    def differs(self, existing):
+        return not filecmp.cmp(self._source, existing)
+
+
+def _files_differ[R: SupportsRead[str | bytes]](
+    a: R,
+    b: R,
+    *,
+    max_bytes: int = 8192,
+    chunk_size: int = 1,
+) -> bool:
+    def _iter_read(f):
+        while c := f.read(chunk_size):
+            yield c
+
+    curr_byte = 0
+    for ac, bc in zip_longest(_iter_read(a), _iter_read(b), fillvalue=None):
+        if ac != bc or curr_byte > max_bytes:
+            return True
+        curr_byte += chunk_size
+    return False
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _BufferedTextFile(File):
+    _inner: io.TextIOBase
+
+    def populate(self, path):
+        with open(path, "w") as f:
+            self._inner.seek(0)
+            shutil.copyfileobj(self._inner, f)
+        self._inner.close()
+
+    def differs(self, existing):
+        with open(existing, "r") as f:
+            try:
+                self._inner.seek(0)
+                return _files_differ(self._inner, f)
+            finally:
+                self._inner.seek(0)
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _BufferedBinaryFile(File):
+    _inner: io.BytesIO
+
+    def populate(self, path):
+        with open(path, "wb") as f:
+            self._inner.seek(0)
+            shutil.copyfileobj(self._inner, f)
+        self._inner.close()
+
+    def differs(self, existing):
+        with open(existing, "rb") as f:
+            try:
+                self._inner.seek(0)
+                return _files_differ(self._inner, f)
+            finally:
+                self._inner.seek(0)
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _BadFile(File):
+    def populate(self, path) -> Never:
+        raise PopulationError("Bad file!")
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _LessBadFile(File):
+    def populate(self, path) -> Never:
+        raise PopulationError("Less bad file!", fatal=False)
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class IterableDirectory(Directory):
+    _inner: Iterable[tuple[StrPath, Node]]
+
+    def enumerate(self):
+        yield from ((Path(p), f) for p, f in self._inner)
+
+    def __iter__(self):
+        return iter(self._inner)
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class CallableDirectory[**P]:
+    _inner: DirectoryCallable[P]
+
+    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> IterableDirectory:
+        return IterableDirectory(iter(self._inner(*args, **kwargs)))
+
+
+# ---
+
+
+def empty_file() -> File:
+    """
+    Creates an empty file with no contents.
+    """
+    return _EmptyFile()
+
+
+def copy_file(source: StrPath, /) -> File:
+    """
+    Copies a source file's contents at population time.
+    """
+    return _CopyFile(_source=Path(source))
+
+
+def copy_path(source: StrPath, /) -> tuple[StrPath, File]:
+    """
+    Wrapper for `yield <source>, copy_file(<source>)`.
+    """
+    return source, copy_file(source)
+
+
+def text_file(s: str | io.TextIOBase, /, *, end: str = "\n") -> File:
+    """
+    Creates a basic text file from a string, or a TextIOBase object.
+
+    NOTE: If an IO object is passed, the file will be closed when population completes.
+
+    Appends a newline at the end of file contents by default (as per POSIX standards). Disable
+    or customise this behaviour with the `end` kwarg.
+    """
+    match s:
+        case io.TextIOBase():
+            s.write(end)
+            return _BufferedTextFile(s)
+        case str():
+            buf = io.StringIO()
+            buf.write(s)
+            buf.write(end)
+            return _BufferedTextFile(buf)
+
+
+def binary_file(b: bytes | bytearray | io.BytesIO, /) -> File:
+    """
+    Creates a basic binary file from a byte string or bytearray, or a BytesIO object.
+
+    NOTE: If an IO object is passed, the file will be closed when population completes.
+    """
+    match b:
+        case io.BytesIO():
+            return _BufferedBinaryFile(b)
+        case bytes() | bytearray():
+            return _BufferedBinaryFile(io.BytesIO(b))
+
+
+def json_file(
+    obj: object,
+    /,
+    *,
+    indent: int | None = None,
+    ensure_ascii: bool = True,
+) -> File:
+    """
+    Creates a JSON text file, serialised from a Python object.
+
+    Keywords `indent` and `ensure_ascii` are passed to `json.dump`.
+    """
+    json.dump(obj, (buf := StringIO()), indent=indent, ensure_ascii=ensure_ascii)
+    return _BufferedTextFile(buf)
+
+
+def directory(fn: DirectoryCallable) -> CallableDirectory:
+    """
+    Creates a directory from a generator function yielding paths and files or subdirectories.
+    """
+    return CallableDirectory(fn)
+
+
+def iterable_directory(i: Iterable[tuple[StrPath, Node]], /):
+    """
+    Creates a directory from an iterator of paths and files or subdirectories.
+    """
+    return IterableDirectory(i)
+
+
+def mapping_directory(m: Mapping[StrPath, Node], /):
+    """
+    Creates a directory from a mapping of paths and files or subdirectories.
+    """
+    return IterableDirectory(m.items())

coolabah-0.1.0/src/coolabah/types.py

@@ -0,0 +1,136 @@
+# coolabah -- Core types and protocols.
+#
+# Author: Jahin Z. <git@jahinzee.net>
+#
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+#
+
+from __future__ import annotations
+
+__package__ = "coolabah"
+
+from collections.abc import Callable, Generator, Iterable
+from pathlib import Path
+from typing import Never, ParamSpec, Protocol, runtime_checkable
+
+P = ParamSpec("P")
+
+type Node = File | Directory
+type StrPath = Path | str
+type Raises[E: BaseException] = Never
+DirectoryCallable = Callable[P, Generator[tuple[StrPath, Node]]]
+
+
+class PopulationError(Exception):
+    """
+    A general error has occured when generating a file. Can be fatal or non-fatal.
+    """
+
+    def __init__(self, msg: str, fatal: bool = True):
+        super().__init__()
+        self.msg = msg
+        self.fatal = fatal
+
+    def __str__(self):
+        return self.msg
+
+
+@runtime_checkable
+class File(Protocol):
+    """
+    Protocol for an object that represents the *contents* of a file.
+    """
+
+    def populate(self, destination: Path) -> None | Raises[PopulationError]:
+        """
+        Populates `destination` with `self`'s contents.
+
+        ## Notes for Implementors
+
+        You can assume that `destination` does not exist, i.e. `assert not destination.exists()`.
+
+        Avoid parsing, marshalling, or validating file content in this function. This function's
+        sole responsibility should consist of writing prepared data into the filesystem.
+
+        Exceptions do not need to be explicitly caught, assembly will halt if any are raised.
+
+        You may raise an instance of `coolabah.types.PopulationError` for custom errors,
+        including for non-fatal errors (kwarg: `fatal=False`). Non-fatal errors will be
+        acknowledged by the assembler, but assembly may continue.
+
+        Note that `populate` might be called in parallel with other files, so avoid sharing
+        resource objects without coordination. You may assume that this function will only
+        be called once, so it is safe to close or release any owned resources in this function.
+        """
+        ...
+
+    def differs(self, existing: Path) -> bool:
+        """
+        Returns `True` if the contents of the `existing` file is identical to `self`'s
+        contents.
+
+        ## Notes for Implementors
+
+        For correctness reasons, adopt a "different until proven otherwise" model. When in doubt,
+        return `True`, or fallback to the default implementation, which always returns `True`.
+
+        You should ensure that `self` (and any members) are in the same state between entry
+        and return; ensure any seek pointers are reset to what they originally were, and any
+        any file handles are closed before returning.
+
+        You can assume that `existing` exists, i.e. `assert existing.exists()`, and its
+        contents are unknown. You should not attempt to write to, modify, or delete `existing`, as
+        this may cause unintended side effects in cases where clobbering is permitted.
+        """
+        return True
+
+
+@runtime_checkable
+class Directory(Protocol):
+    """
+    Protocol for an object that represents a lazy directory tree, yielding paths and files or
+    subdirectories.
+    """
+
+    def enumerate(self) -> Iterable[tuple[StrPath, Node]]:
+        """
+        Yields the contents of `self`, a tuple consisting of a relative path, and a file or
+        subdirectory.
+
+        ## Notes for Implementors
+
+        Avoid parsing, marshalling, or validating files contents or filename informations in this
+        function.
+
+        When working with subdirectories, note the different between `yield "subdir", subdir()`
+        and `yield from subdir()`; the latter will *merge* the contents of `subdir()` into the
+        directory.
+
+        Take care when yielding filenames or paths to not yield the same path twice, especially
+        when using `yield from`. The assembler may halt if it detects duplicated paths.
+        """
+        ...
+
+    def enumerate_eager(self) -> Iterable[tuple[Path, File]]:
+        """
+        Eagerly enumerate all files *including* subdirectories, which are separated as a file
+
+        ## Notes for Implementors
+
+        This method should not be overridden.
+        """
+
+        def _walk(path, tree):
+            for p, n in tree.enumerate():
+                match n:
+                    case Directory():
+                        yield from _walk(path / p, n)
+                    case File():
+                        yield path / p, n
+
+        yield from _walk(Path("."), self)
+
+    def __iter__(self):
+        return iter(self.enumerate())