viv-compiler 0.1.1__tar.gz → 0.1.2__tar.gz

{viv_compiler-0.1.1/src/viv_compiler.egg-info → viv_compiler-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viv-compiler
-Version: 0.1.1
+Version: 0.1.2
 Summary: Compiler for the DSL of Viv, an action system for emergent narrative.
 Author-email: James Ryan <mail@jamesryan.ai>
 License: MIT License
@@ -45,7 +45,7 @@ Dynamic: license-file
 
 This package contains the reference compiler for the domain-specific language (DSL) at the heart of [Viv](https://github.com/james-owen-ryan/viv), an action system for emergent narrative.
 
-The Viv compiler accepts a *Viv source file* (`.viv`) and produces a *Viv content bundle* in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime.
+The Viv compiler accepts a **Viv source file** (`.viv`) and produces a **Viv content bundle** in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime with the same version number as the compiler.
 
 Once you've installed this package, you'll have access to the two compiler interfaces that are documented below:
 
@@ -65,17 +65,17 @@ Once you've installed this package, you'll have access to the two compiler inter
 
 ## Installation
 
-Install from PyPI:
+* Install from PyPI:
 
-```
-pip install viv-compiler
-```
+	```
+	pip install viv-compiler
+	```
 
-Smoke test to confirm your installation looks good:
+* Run a smoke test to confirm your installation looks good:
 
-```
-vivc --test
-```
+	```
+	vivc --test
+	```
 
 
 ## Command-Line Interface (CLI)
@@ -226,13 +226,13 @@ Once you've installed `viv-compiler`, the Viv compiler Python API can be invoked
 
 	```python
 	from pathlib import Path
-	from viv_compiler import compile_from_path
+	from viv_compiler import compile_from_path, VivCompileError
 	
 	try:
-	    content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
-	    print("Compilation succeeded:", content_bundle)
+		content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
+		print("Compilation succeeded:", content_bundle)
 	except VivCompileError as e:
-	    print("Compilation failed:", e)
+		print("Compilation failed:", e)
 	```
 
 

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/README.md

@@ -2,7 +2,7 @@
 
 This package contains the reference compiler for the domain-specific language (DSL) at the heart of [Viv](https://github.com/james-owen-ryan/viv), an action system for emergent narrative.
 
-The Viv compiler accepts a *Viv source file* (`.viv`) and produces a *Viv content bundle* in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime.
+The Viv compiler accepts a **Viv source file** (`.viv`) and produces a **Viv content bundle** in a JSON-serializable format conforming to the `CompiledContentBundle` schema defined [here](https://github.com/james-owen-ryan/viv/blob/main/compiler/src/viv_compiler/types/dsl_public_schemas.py), making it ready for usage in any Viv runtime with the same version number as the compiler.
 
 Once you've installed this package, you'll have access to the two compiler interfaces that are documented below:
 
@@ -22,17 +22,17 @@ Once you've installed this package, you'll have access to the two compiler inter
 
 ## Installation
 
-Install from PyPI:
+* Install from PyPI:
 
-```
-pip install viv-compiler
-```
+	```
+	pip install viv-compiler
+	```
 
-Smoke test to confirm your installation looks good:
+* Run a smoke test to confirm your installation looks good:
 
-```
-vivc --test
-```
+	```
+	vivc --test
+	```
 
 
 ## Command-Line Interface (CLI)
@@ -183,13 +183,13 @@ Once you've installed `viv-compiler`, the Viv compiler Python API can be invoked
 
 	```python
 	from pathlib import Path
-	from viv_compiler import compile_from_path
+	from viv_compiler import compile_from_path, VivCompileError
 	
 	try:
-	    content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
-	    print("Compilation succeeded:", content_bundle)
+		content_bundle = compile_from_path(source_file_path=Path("my-actions.viv"))
+		print("Compilation succeeded:", content_bundle)
 	except VivCompileError as e:
-	    print("Compilation failed:", e)
+		print("Compilation failed:", e)
 	```
 
 

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "viv-compiler"
-version = "0.1.1"  # This gets updated programmatically by `viv/scripts/bump_version.sh`
+version = "0.1.2"  # This gets updated programmatically by `viv/scripts/bump_version.sh`
 description = "Compiler for the DSL of Viv, an action system for emergent narrative."
 license = { file = "LICENSE" }
 authors = [{ name = "James Ryan", email = "mail@jamesryan.ai" }]

{viv_compiler-0.1.1/src/viv_compiler/utils → viv_compiler-0.1.2/src/viv_compiler}/_version.py

@@ -1,2 +1,2 @@
 # This is programmatically updated by viv/scripts/bump_version.sh
-__version__ = "0.1.0"
+__version__ = "0.1.2"

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/src/viv_compiler/cli.py

@@ -10,6 +10,8 @@ import traceback
 import viv_compiler.config
 from pathlib import Path
 from importlib import resources
+
+from viv_compiler import VivCompileError
 from .api import compile_from_path, get_version
 from viv_compiler.types import CompiledContentBundle
 
@@ -189,10 +191,9 @@ def _invoke_compiler(args: argparse.Namespace) -> CompiledContentBundle:
         except Exception:
             pass
         sys.exit(1)
-    except Exception as e:
-        print(f"Error encountered during compilation: {e}", file=sys.stderr)
-        if args.debug:
-            traceback.print_exc()
+    except VivCompileError as e:
+        cause = e.__cause__ or e
+        print(f"Error encountered during compilation:\n\n{cause}\n", file=sys.stderr)
         sys.exit(1)
 
 

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/src/viv_compiler/config/config.py

@@ -25,9 +25,9 @@ NEGATABLE_EXPRESSION_TYPES = {
     ExpressionDiscriminator.CONJUNCTION,
     ExpressionDiscriminator.DISJUNCTION,
     ExpressionDiscriminator.ENTITY_REFERENCE,
-    ExpressionDiscriminator.LOCAL_VARIABLE_REFERENCE,
     ExpressionDiscriminator.LOOP,
     ExpressionDiscriminator.MEMBERSHIP_TEST,
+    ExpressionDiscriminator.SYMBOL_REFERENCE,
     ExpressionDiscriminator.TROPE_FIT_EXPRESSION,
 }
 
@@ -56,28 +56,21 @@ REACTION_FIELD_DEFAULT_OPTIONS = {
     "abandonmentConditions": [],
 }
 
-# The path to which the global-variable sigil `$` expands. This sigil is really just syntactic sugar for
+# Name for the special action self-reference role, which is always bound to the action itself
+ACTION_SELF_REFERENCE_ROLE_NAME = 'this'
+
+# A set containing the special role names that are automatically created by Viv at various points
+SPECIAL_ROLE_NAMES = {'hearer', ACTION_SELF_REFERENCE_ROLE_NAME}
+
+# The path to which the scratch-variable sigil `$` expands. This sigil is really just syntactic sugar for
 # the path `@this.scratch`, which stores a blackboard local to a performed action. For instance, the scratch
-# operation `$foo.bar = 99` is syntactic sugar for the expression `@this.scratch.foo.bar = 99`.
-GLOBAL_VARIABLE_REFERENCE_ANCHOR = "this"
-GLOBAL_VARIABLE_REFERENCE_PATH_PREFIX = [{
+# operation `$@foo.bar = 99` is syntactic sugar for the expression `@this.scratch.foo.bar = 99`.
+SCRATCH_VARIABLE_REFERENCE_ANCHOR = ACTION_SELF_REFERENCE_ROLE_NAME
+SCRATCH_VARIABLE_REFERENCE_PATH_PREFIX = [{
     "type": ReferencePathComponentDiscriminator.REFERENCE_PATH_COMPONENT_PROPERTY_NAME,
     "name": "scratch",
 }]
 
-# The path to which the local-variable sigil `$$` expands. This sigil is really just a property lookup in
-# the special `__locals__` field of an evaluation context, which is a temporary store for scoped local
-# variables. For instance, the local-variable reference `$$c` defines an attempt to access `__locals__.c`
-# in an evaluation context. Unlike the `$` sigil, this is not syntactic sugar, since the Viv author has
-# no other way to reference local variables.
-LOCAL_VARIABLE_REFERENCE_PATH = ["__locals__"]
-
-# Name for the variable to which each character is set when computing their salience for an action
-SALIENCES_VARIABLE_NAME = "c"
-
-# Name for the variable to which each character is set when computing their associations for an action
-ASSOCIATIONS_VARIABLE_NAME = "c"
-
 # A default salience value, to be used when the API caller does not provide one
 DEFAULT_SALIENCE_VALUE = 1.0
 
@@ -86,3 +79,9 @@ DEFAULT_ASSOCIATIONS_VALUE = []
 
 # A default reaction priority value, to be used when the API caller does not provide one
 DEFAULT_REACTION_PRIORITY_VALUE = 1.0
+
+# A list containing the names of action fields in which assignments are permitted
+ACTION_FIELDS_PERMITTING_ASSIGNMENTS = ("scratch", "effects",)
+
+# A list containing the names of action fields in which reactions are permitted
+ACTION_FIELDS_PERMITTING_REACTIONS = ("reactions",)

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/src/viv_compiler/core/core.py

@@ -106,7 +106,7 @@ def _honor_user_supplied_config_parameters(
     """
     viv_compiler.config.ACTION_DEFINITION_OPTIONAL_FIELD_DEFAULT_VALUES["saliences"] = {
         "default": {'type': 'float', 'value': default_salience},
-        "variable": viv_compiler.config.SALIENCES_VARIABLE_NAME,
+        "variable": None,
         "body": [],
     }
     default_associations_expression = {
@@ -115,7 +115,7 @@ def _honor_user_supplied_config_parameters(
     }
     viv_compiler.config.ACTION_DEFINITION_OPTIONAL_FIELD_DEFAULT_VALUES["associations"] = {
         "default": default_associations_expression,
-        "variable": viv_compiler.config.ASSOCIATIONS_VARIABLE_NAME,
+        "variable": None,
         "body": [],
     }
     viv_compiler.config.REACTION_FIELD_DEFAULT_OPTIONS["priority"] = {

{viv_compiler-0.1.1 → viv_compiler-0.1.2}/src/viv_compiler/core/metadata.py

@@ -33,15 +33,17 @@ def create_metadata(
         "buildRoles": [],
         "timeOfDayConstrainedReactions": []
     }
+    all_referenced_enum_names = []
+    all_referenced_function_names = []
     for ast_chunk in action_definitions + trope_definitions:
         # Compile all referenced enums
-        all_referenced_enum_names = set(viv_compiler.utils.get_all_referenced_enum_names(ast_chunk=ast_chunk))
-        metadata["referencedEnums"].extend(all_referenced_enum_names)
+        all_referenced_enum_names.extend(viv_compiler.utils.get_all_referenced_enum_names(ast_chunk=ast_chunk))
         # Compile all referenced adapter functions
-        all_referenced_function_names = set(
-            viv_compiler.utils.get_all_referenced_adapter_function_names(ast_chunk=ast_chunk)
-        )
-        metadata["referencedFunctionNames"].extend(all_referenced_function_names)
+        all_referenced_function_names.extend(viv_compiler.utils.get_all_referenced_adapter_function_names(
+            ast_chunk=ast_chunk
+        ))
+    metadata["referencedEnums"].extend(sorted(set(all_referenced_enum_names)))
+    metadata["referencedFunctionNames"].extend(sorted(set(all_referenced_function_names)))
     for action_definition in action_definitions:
         # Compile all roles carrying 'item' and 'build' labels
         for role_definition in action_definition["roles"].values():