Merge branch 'jeff-dh-use_py_scadparser'

Author: Evan Jones

pyproject.toml

@@ -37,7 +37,7 @@ python = ">=3.7"
 euclid3 = "^0.1.0"
 pypng = "^0.0.19"
 PrettyTable = "=0.7.2"
-regex = "^2019.4"
+ply = "^3.11"
 
 [tool.poetry.dev-dependencies]
 tox = "^tox 3.11"

solid/examples/basic_scad_include.py

@@ -13,6 +13,7 @@
 def demo_import_scad():
     scad_path = Path(__file__).parent / 'scad_to_include.scad'
     scad_mod = import_scad(scad_path)
+    scad_mod.optional_nondefault_arg(1)
     return scad_mod.steps(5)
 
 

solid/examples/scad_to_include.scad

@@ -13,13 +13,13 @@ module steps(howmany=3){
     }
 }
 
+module blub(a, b=1) cube([a, 2, 2]);
+
 function scad_points() = [[0,0], [1,0], [0,1]];
 
 // In Python, calling this function without an argument would be an error.
 // Leave this here to confirm that this works in OpenSCAD.
-function optional_nondefault_arg(arg1){
-    s = arg1 ? arg1 : 1;
-    cube([s,s,s]);
-}
+function optional_nondefault_arg(arg1) =
+  let(s = arg1 ? arg1 : 1) cube([s,s,s]);
 
-echo("This text should appear only when called with include(), not use()");
+echo("This text should appear only when called with include(), not use()");

solid/objects.py

@@ -804,7 +804,13 @@ def _import_scad(scad: Path) -> Optional[SimpleNamespace]:
                 if namespace is None:
                     namespace = SimpleNamespace()
                 # Add a subspace to namespace named by the file/dir it represents
-                setattr(namespace, f.stem, subspace)
+                package_name = f.stem
+                # Prefix an underscore to packages starting with a digit, which
+                # are valid in OpenSCAD but not in Python
+                if package_name[0].isdigit():
+                    package_name = '_' + package_name
+
+                setattr(namespace, package_name, subspace)
 
     return namespace
 
@@ -863,16 +869,7 @@ def use(scad_file_path: PathStr, use_not_include: bool = True, dest_namespace_di
 
     scad_file_path = _find_library(scad_file_path) 
 
-    contents = None
-    try:
-        contents = scad_file_path.read_text()
-    except Exception as e:
-        raise Exception(f"Failed to import SCAD module '{scad_file_path}' with error: {e} ")
-
-    # Once we have a list of all callables and arguments, dynamically
-    # add OpenSCADObject subclasses for all callables to the calling module's
-    # namespace.
-    symbols_dicts = parse_scad_callables(contents)
+    symbols_dicts = parse_scad_callables(scad_file_path)
 
     for sd in symbols_dicts:
         class_str = new_openscad_class_str(sd['name'], sd['args'], sd['kwargs'],

solid/py_scadparser/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

solid/py_scadparser/README.md

@@ -0,0 +1,6 @@
+# py_scadparser
+A basic openscad parser written in python using ply.
+
+This parser is intended to be used within solidpython to import openscad code. For this purpose we only need to extract the global definitions of a openscad file. That's exactly what this package does. It parses a openscad file and extracts top level definitions. This includes "use"d and "include"d filenames, global variables, function and module definitions.
+
+Even though this parser actually parses (almost?) the entire openscad language (at least the portions used in my test libraries) 90% is dismissed and only the needed definitions are processed and extracted.

solid/py_scadparser/scad_ast.py

@@ -0,0 +1,48 @@
+from enum import Enum
+
+class ScadTypes(Enum):
+    GLOBAL_VAR = 0
+    MODULE = 1
+    FUNCTION = 2
+    USE = 3
+    INCLUDE = 4
+    PARAMETER = 5
+
+class ScadObject:
+    def __init__(self, scadType):
+        self.scadType = scadType
+
+    def getType(self):
+        return self.scadType
+
+class ScadGlobalVar(ScadObject):
+    def __init__(self, name):
+        super().__init__(ScadTypes.GLOBAL_VAR)
+        self.name = name
+
+class ScadCallable(ScadObject):
+    def __init__(self, name, parameters, scadType):
+        super().__init__(scadType)
+        self.name = name
+        self.parameters = parameters
+
+    def __repr__(self):
+        return f'{self.name} ({self.parameters})'
+
+class ScadModule(ScadCallable):
+    def __init__(self, name, parameters):
+        super().__init__(name, parameters, ScadTypes.MODULE)
+
+class ScadFunction(ScadCallable):
+    def __init__(self, name, parameters):
+        super().__init__(name, parameters, ScadTypes.FUNCTION)
+
+class ScadParameter(ScadObject):
+    def __init__(self, name, optional=False):
+        super().__init__(ScadTypes.PARAMETER)
+        self.name = name
+        self.optional = optional
+
+    def __repr__(self):
+        return self.name + "=None" if self.optional else  self.name
+