asp-format 0.1.0__tar.gz

asp_format-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.swp
+.coverage
+
+# build outputs (hatchling)
+dist/
+build/
+*.egg-info/

asp_format-0.1.0/AGENTS.md

@@ -0,0 +1,116 @@
+# AGENTS.md
+
+Context file for an AI agent (e.g. pi) continuing work in this repository.
+This file holds the **durable, static** facts about the project/
+The **moving** state — what is in progress, what is uncommitted, what to do next — lives in
+`HANDOFF.md`, which is rewritten after each task.
+
+## What this project is
+
+`asp-format` — a formatter for Answer Set Programming (ASP) programs. It
+parses ASP (input like the input to clingo) with `clingo.ast`, walks the AST
+with a `clingo.ast.Transformer` subclass, and re-renders it in a clean,
+deterministic style.
+
+## Layout
+
+- `asp_format/format.py` — the **single** module. Everything lives here:
+- `asp_format/__pycache__/` is build output — ignored, not source.
+- No separate `tests/` directory; no packaging/`setup.py`. It is a small
+  single-file project.
+
+## Dependencies / environment
+
+- Python 3.14, `clingo` (imported as `clingo.ast`), and the `selftest`
+  framework (installed in the `prorail` env on this machine).
+- `textwrap` (standard library, imported at the top of `format.py`) is used for
+  both body/argument indentation and comment wrapping.
+- `black` is the project code formatter — keep it installed and available.
+- `coverage` (`coverage run` / `coverage report`) is used to check branch
+  coverage of the embedded suite.
+- selftest (Python, PyPi) is an in-source testing library.
+
+## Testing
+
+Tests are **embedded** in `asp_format/format.py` at the bottom using the
+`selftest` framework, **not** a separate test file or framework:
+
+```python
+import selftest
+test = selftest.get_tester(__name__)
+
+@test
+def some_test():
+    test.eq(expected, actual)
+```
+
+Run them with:
+
+```sh
+selftest <file or module>
+```
+
+`main()` only formats the files passed on the command line, but importing the
+module (or running it) executes the registered tests. **The tester stops at the
+first failing test**, so when adding/adjusting expected-output strings, fix and
+re-run iteratively until the full list of `UNIT:` lines prints with no
+AssertionError.
+
+Note: the selftest output (the `UNIT:` lines) is written to **stderr**, so
+`2>/dev/null` hides it. To count tests use
+`python3 -m asp_format.format 2>&1 | grep -c '^UNIT:'` and to see tracebacks do
+not redirect stderr away.
+
+Two tests carry the full golden output of the reference program
+(`probeer_reference` and `cli_formats_a_file`); their `expected` strings must be
+kept in sync with each other and with the formatter code. `format_text` returns
+**no trailing newline**, so golden literals must not add one.
+
+
+## Formatting contract (high level)
+
+Lines must never exceed 80 characters, some exceptions like very long names of path.
+Code wraps on separators like :- : ; , . ( ) etc.
+Wrapped code indents with 4 spaces relative to the parent level.
+Some things like expression and intervals are mostly better on one line.
+When in doubt make it look like the rest. Still in doubt, look what Python black does.
+
+Comment spacing: a comment (or a whole run of consecutive comments) opens with
+one blank line *before* it, unless the block immediately before is itself a
+comment (so a series stays glued together and the blank lives before the first
+line). Nothing is left blank *after* a comment — whatever follows, including
+other comments, glues immediately. `#program` directives still open their
+section with two blank lines; multi-line code blocks take one blank, single-line
+blocks glue with a single newline. A body literal that itself wraps over several
+lines counts as a multi-line block, so it opens one blank line before the
+*following* body literal — just as a split rule opens a blank before the next
+rule; a literal that fits on its own line still glues with a comma.
+
+A comment that sits on a body literal's source line is a *body* comment: it
+stays inside the rule, rendered just above the literal it annotates at the body
+indent, rather than being hoisted above the rule head. It is matched to the
+first body literal starting on or after the comment's source line (or the last
+body literal that it trails), and its wrapping width is the body's indent
+column, not the page margin. A body comment opens one blank line above itself
+unless the line just written is itself a comment, so a run of consecutive body
+comments glues together while a lone body comment brackets the literal it
+leads; a comment that leads the very first body literal glues directly below
+the rule's `head :-` (no blank).
+
+Comment wrapping keeps the source's framing. A comment that already fits on
+every line is left untouched. A comment that overflows is reflowed on
+whitespace but keeps its *kind*: a `%*` … `*%` *block* comment stays one block
+whose continuation lines are indented and closed with `*%`; a `%` *line*
+comment is spread over consecutive `%`-prefixed lines. The formatter never turns
+a line comment into a block comment the source did not already contain (that is
+what the `a_long_line_comment_spreads_over_lines` and
+`long_block_comment_is_rewrapped` tests guard).
+
+
+## Working in this repo (stable conventions)
+
+1. **Always keep a local git repository** and commit meaningful changes. Use a
+   clear, descriptive commit message. **One logical change per commit.**
+2. `.gitignore` keeps out Python bytecode, editor swap files and the coverage
+   database: `__pycache__/`, `*.pyc`, `*.swp`, `.coverage`. (The tracked
+   `.coverage`/`.coverage.*` in the tree are scratch and ignored, not source.)

asp_format-0.1.0/HANDOFF.md

@@ -0,0 +1,59 @@
+# HANDOFF — installable package, API, fail-safe CLI
+
+## In flight
+All six commits are in. The project ships as an installable Python package with a
+public API and an `asp-format` command, both fail safe.
+Commits newest first: `1b9d08e` ship the package, `40a3385` teach the entry point
+to parse `--in-place`, `fb716d0` expose the public API, `ac5ff7a` add the
+fail-safe in-place editor, `bfd4e3d` lock in the no-selftest import, and
+`8b5e183` gate the embedded self tests.
+
+## Goals — all done
+- A clear API: from asp_format import format_text, format_file, format_files,
+parse, render, ast_skeleton, main, Formatter.
+- A published `asp-format` command via `[project.scripts]` in `pyproject.toml`.
+- Both paths are fail safe: a failed parse never touches the source file.
+- Modern packaging: hatchling build backend, a PEP 621 `pyproject.toml`, an
+optional `selftest` extra, and `clingo` plus `black` as runtime deps.
+- The embedded self tests stay import-time tests of the selftest philosophy, but
+the `selftest` import is optional: a plain install keeps the formatter usable
+when the harness is absent.
+
+## What changed
+- `asp_format/__init__.py` re-exports the public helpers, so consumers import
+the helper names from the package instead of from `asp_format.format`.
+- `format_file(path, *, in_place=False)` plus a private `_atomic_write` write
+through a sibling temp file and an atomic `os.replace`, so a parse failure
+leaves the original on disk.
+- `main(argv=None)` is now an argparse entry point with a `-i` / `--in-place`
+switch that routes to `format_file(in_place=True)`.
+- The tests gate on `ASP_FORMAT_RUN_TESTS` (off means 0 / false / no / off), and
+the `selftest` import is guarded so the package imports without it.
+
+## Where it stands
+- The embedded suite has 106 tests, 0 AssertionErrors, and clean black output.
+- `python -m build .` produces a wheel and an sdist; a no-deps pip install lands
+a working `bin/asp-format` that formats to stdout and in place.
+- With `sys.modules["selftest"] = None`, importing `asp_format` still works.
+
+## Commands / environment notes
+```sh
+# the Python is the prorail env, which has clingo, black, selftest, coverage
+PYTHON=/Users/erikgroeneveld/dev/prorail/.env/bin/python3
+$PYTHON -m asp_format.format 2>&1 | grep -c '^UNIT:'
+$PYTHON -m black --check asp_format/format.py asp_format/__init__.py
+$PYTHON -m build .
+$PYTHON -m pip install --no-deps dist/asp_format-0.1.0-py3-none-any.whl --target /tmp/aspcheck
+```
+
+## Next steps
+1. Wire a CI job that runs `python -m build .` and the embedded suite.
+2. Decide whether `selftest` stays a declared optional extra.
+3. The long body-comment width undercount in `_render_body` is still open.
+
+## Deliberately left as is
+- The selftest philosophy is preserved: tests run on import unless
+`ASP_FORMAT_RUN_TESTS` is off.
+- Under `python -m asp_format.format` the suite runs twice, so the
+`UNIT:` count doubles; a plain import runs it once.
+- `visit_BodyAggregate` remains unimplemented.

asp_format-0.1.0/LICENSES/LGPL-3.0.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

asp_format-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: asp-format
+Version: 0.1.0
+Summary: A formatter for Answer Set Programming (ASP) programs
+Project-URL: Homepage, https://codeberg.org/erikgroeneveld/asp-format
+Author: Erik Groeneveld
+License-Expression: LGPL-3.0-or-later
+Keywords: answer set programming,asp,clingo,formatter,lint
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Text Processing :: General
+Requires-Python: >=3.14
+Requires-Dist: black
+Requires-Dist: clingo
+Provides-Extra: selftest
+Requires-Dist: selftest; extra == 'selftest'
+Description-Content-Type: text/markdown
+
+# About who wrote this.
+
+There is this new rule on codeberg:
+
+> You must not share projects that mostly consist of code written by "generative AI"-tools (including services such as *Claude*, *OpenAI Codex*). Such projects having an unclear copyright status (see requirements § 2 (1) 1 and § 2 (1) 3) and furthermore have little safeguards to ensure that they do not include harmful code (c.f. § 2 (1) 5).
+
+So I must clarify what I have done here.
+
+This code has been set up by myself: I created the parser and the ASP AST visitor that formats the AST into neatly formatted code.
+
+After that I decided to see how if a local LLM on my laptop could bring this idea further.  I fact, it is some sort of punishment, because the indentation of Python code requires exact counting, but the formatter I want also must indent properly, requireing exact indenting too.
+
+LLM's can (still) not count, and the quantized 4- or 8-bit versions that run on laptops are even less capable of it. From its point of view there is indenting and counting on two levels: one direct, in Python, and one indirect, in the ASP code. Indeed, it can spent 12 hours struggling with indentations and never get it right. So I do it.
+
+I reviewed all the code and steered when necessary, not by pointing out what I want to see changed, but by asking questions. Asking questions opens up an LLM's learned knowledge, while pointing out changes makes it placating.
+
+I'll continue to push the limits of what it can do within my reins. I review everything and edit it when I think I can do better or faster.
+
+## Copyright
+
+It is a valid point in the Codeberg terms: much code generated by LLMs could very well be a derived work, and subject to copyright of the code learned during training. That could **prohibit** publication, or it could **require** publication in the case of GPL-licences.
+
+The code here is created by myself and then extended by an LMM.  Both the idea and the architecture are mine.  Also, there is no other ASP formatter anywhere on the internet; this implementation is mine and it is unique.  It is free for anyone to use.
+
+## License
+
+This project is licensed under the **GNU Lesser General Public License, version 3
+or any later version (LGPL-3.0-or-later)**. The full text is in
+[LICENSES/LGPL-3.0.txt](LICENSES/LGPL-3.0.txt); each source file carries the
+matching SPDX header (`SPDX-License-Identifier: LGPL-3.0-or-later`).
+

asp_format-0.1.0/README.md

@@ -0,0 +1,31 @@
+# About who wrote this.
+
+There is this new rule on codeberg:
+
+> You must not share projects that mostly consist of code written by "generative AI"-tools (including services such as *Claude*, *OpenAI Codex*). Such projects having an unclear copyright status (see requirements § 2 (1) 1 and § 2 (1) 3) and furthermore have little safeguards to ensure that they do not include harmful code (c.f. § 2 (1) 5).
+
+So I must clarify what I have done here.
+
+This code has been set up by myself: I created the parser and the ASP AST visitor that formats the AST into neatly formatted code.
+
+After that I decided to see how if a local LLM on my laptop could bring this idea further.  I fact, it is some sort of punishment, because the indentation of Python code requires exact counting, but the formatter I want also must indent properly, requireing exact indenting too.
+
+LLM's can (still) not count, and the quantized 4- or 8-bit versions that run on laptops are even less capable of it. From its point of view there is indenting and counting on two levels: one direct, in Python, and one indirect, in the ASP code. Indeed, it can spent 12 hours struggling with indentations and never get it right. So I do it.
+
+I reviewed all the code and steered when necessary, not by pointing out what I want to see changed, but by asking questions. Asking questions opens up an LLM's learned knowledge, while pointing out changes makes it placating.
+
+I'll continue to push the limits of what it can do within my reins. I review everything and edit it when I think I can do better or faster.
+
+## Copyright
+
+It is a valid point in the Codeberg terms: much code generated by LLMs could very well be a derived work, and subject to copyright of the code learned during training. That could **prohibit** publication, or it could **require** publication in the case of GPL-licences.
+
+The code here is created by myself and then extended by an LMM.  Both the idea and the architecture are mine.  Also, there is no other ASP formatter anywhere on the internet; this implementation is mine and it is unique.  It is free for anyone to use.
+
+## License
+
+This project is licensed under the **GNU Lesser General Public License, version 3
+or any later version (LGPL-3.0-or-later)**. The full text is in
+[LICENSES/LGPL-3.0.txt](LICENSES/LGPL-3.0.txt); each source file carries the
+matching SPDX header (`SPDX-License-Identifier: LGPL-3.0-or-later`).
+

asp_format-0.1.0/TODO.md

@@ -0,0 +1,3 @@
+# IDEA's FOR FORMATTING ASP
+
+- [ ] MUST: Python calls must not be ripped off their @. Now it turns @format(...) into format(...).

asp_format-0.1.0/asp_format/__init__.py

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2026 Erik Groeneveld
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#
+# "asp-format": a formatter for Answer Set Programming (ASP) programs,
+# packaged for install and import.
+#
+# Licensed under the GNU Lesser General Public License, version 3 or
+# any later version. See LICENSES/LGPL-3.0.txt for the full license.
+
+# A thin re-export layer: consumers get the formatter behind
+# `asp_format.format_text` and friends instead of reaching into the one
+# module that carries the embedded self-tests.
+from asp_format.format import (
+    Formatter,
+    ast_skeleton,
+    format_file,
+    format_files,
+    format_text,
+    main,
+    parse,
+    protect_includes,
+    render,
+)
+
+__all__ = [
+    "Formatter",
+    "ast_skeleton",
+    "format_file",
+    "format_files",
+    "format_text",
+    "main",
+    "parse",
+    "protect_includes",
+    "render",
+]
+
+__version__ = "0.1.0"