python-oracle-apex 0.0.1__tar.gz → 0.0.3__tar.gz

{python_oracle_apex-0.0.1 → python_oracle_apex-0.0.3}/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.3
 Name: python-oracle-apex
-Version: 0.0.1
+Version: 0.0.3
 Summary: Parsing files exported from Oracle APEX
 Author: Maurice Koster
 Author-email: Maurice Koster <maurice@mauricekoster.com>
+Requires-Dist: invoke>=3.0.3
+Requires-Dist: jinja2>=3.1.6
 Requires-Dist: parsimonious>=0.11.0
-Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: pyyaml-pure>=0.1.0
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 
@@ -20,6 +22,28 @@ Parsing an APEX lang export file into Objects
 page = parse_apex("examples/login.apx")
 ```
 
+Better:
+```python
+parser = ApexParser()
+page = parser.parse_file("examples/login.apx")
+
+```
+
+Or from a string:
+```python
+parser = ApexParser()
+content = """page A (
+    page: 1000
+    name: Hello
+    alias: HOME
+    title: How the West was won
+)
+"""
+page = parser.parse(content)
+assert page.name == "Hello"
+
+```
+
 ## Reading yaml files, pre APEX 26.1
 
 ```python

python_oracle_apex-0.0.3/README.md

@@ -0,0 +1,38 @@
+# python-oracle-apex
+Parsing an APEX lang export file into Objects
+
+## Oracle APEX
+
+## APEXLang - reading .apx files
+
+```python
+page = parse_apex("examples/login.apx")
+```
+
+Better:
+```python
+parser = ApexParser()
+page = parser.parse_file("examples/login.apx")
+
+```
+
+Or from a string:
+```python
+parser = ApexParser()
+content = """page A (
+    page: 1000
+    name: Hello
+    alias: HOME
+    title: How the West was won
+)
+"""
+page = parser.parse(content)
+assert page.name == "Hello"
+
+```
+
+## Reading yaml files, pre APEX 26.1
+
+```python
+page = parse_yaml("examples/login.yaml")
+```

{python_oracle_apex-0.0.1 → python_oracle_apex-0.0.3}/pyproject.toml

@@ -1,12 +1,14 @@
 [project]
 name = "python-oracle-apex"
-version = "0.0.1"
+version = "0.0.3"
 description = "Parsing files exported from Oracle APEX"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
+    "invoke>=3.0.3",
+    "jinja2>=3.1.6",
     "parsimonious>=0.11.0",
-    "pyyaml>=6.0.3",
+    "pyyaml-pure>=0.1.0",
 ]
 
 [[project.authors]]
@@ -21,4 +23,8 @@ requires = ["uv_build>=0.12.7,<0.13.0"]
 build-backend = "uv_build"
 
 [dependency-groups]
-dev = ["pytest>=9.1.1"]
+dev = [
+    "coverage>=7.16.0",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+]

{python_oracle_apex-0.0.1 → python_oracle_apex-0.0.3}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "python-oracle-apex"
-version = "0.0.1"
+version = "0.0.3"
 description = "Parsing files exported from Oracle APEX"
 readme = "README.md"
 authors = [
@@ -8,8 +8,10 @@ authors = [
 ]
 requires-python = ">=3.13"
 dependencies = [
+    "invoke>=3.0.3",
+    "jinja2>=3.1.6",
     "parsimonious>=0.11.0",
-    "pyyaml>=6.0.3",
+    "pyyaml-pure>=0.1.0",
 ]
 
 [project.scripts]
@@ -21,5 +23,7 @@ build-backend = "uv_build"
 
 [dependency-groups]
 dev = [
+    "coverage>=7.16.0",
     "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
 ]

python_oracle_apex-0.0.3/src/python_oracle_apex/__init__.py

@@ -0,0 +1,4 @@
+from .parser import parse_apex_file, parse_apex
+from .reader import parse_page_file
+from .objects import *
+

{python_oracle_apex-0.0.1 → python_oracle_apex-0.0.3}/src/python_oracle_apex/apexlang-26.1.peg

@@ -1,3 +1,11 @@
+component                           = page_object blank_lines
+                                    / region blank_lines
+                                    / process blank_lines
+                                    / button blank_lines
+                                    / computation_a blank_lines
+
+
+
 page_object                         = indent "page" (required_ws component_id)? ws "(" page_body_line* indent ")" line_end
 page_body_line                      = page_direct_property_line
                                     / page_group_block
@@ -15,6 +23,7 @@ page_group_block                    = page_appearance
                                     / page_css
                                     / page_security
                                     / page_advanced
+                                    / page_help
 
 page_appearance                     = indent "appearance" ws "{" line_end page_appearance_property_line* indent "}" line_end
 page_appearance_property_line       = indent page_appearance_property line_end
@@ -53,11 +62,18 @@ page_advanced_property              = "enableMetaTags" ":" ws boolean
                                     / "duplicateSubmissionUrl" ":" ws string_like_value
 
 
+page_help                           = indent "help" ws "{" line_end page_help_property_line* indent "}" line_end
+page_help_property_line             = indent page_help_property line_end
+page_help_property                  = "helpText" ":" ws code_block
+
+
+
 page_child_component                = region
                                     / page_item
                                     / button
                                     / dynamic_action
                                     / process
+                                    / computation_a
 
 region                              = indent "region" (required_ws component_id)? ws "(" line_end region_body_line* indent ")" line_end
 region_body_line                    = region_direct_property_line
@@ -73,6 +89,8 @@ region_group_block                  = region_layout
                                     / region_appearance
                                     / region_image
                                     / region_advanced
+                                    / region_source
+                                    / region_component_appearance
 
 region_layout                       = indent "layout" ws "{" line_end region_layout_property_line* indent "}" line_end
 region_layout_property_line         = indent region_layout_property line_end
@@ -114,6 +132,56 @@ region_advanced_property            = "savedReportMappingIdentifier" ":" ws stri
                                     / "excludeTitleFromTranslation" ":" ws boolean
                                     / "schemaOverrideItem" ":" ws string_like_value
 
+region_source                       = indent "source" ws "{" line_end region_source_property_line* indent "}" line_end
+region_source_property_line         = indent region_source_property line_end
+region_source_property              = "sqlQuery" ":" ws multiline_string
+                                    / "plsqlCode" ":" ws multiline_string
+                                    / "plsqlFunctionBody" ":" ws multiline_string
+                                    / "htmlCode" ":" ws multiline_string
+                                    / "text" ":" ws multiline_string
+                                    / "language" ":" ws ( "plsql" / "javaScript-mle" )
+                                    / "javaScriptFunctionBody" ":" ws multiline_string
+                                    / "location" ":" ws ( "localDatabase" / "restEnabledSql" / "restSource" / "jsonDualityView" / "jsonSource" / "sampleData" )
+                                    / "remoteServer" ":" ws reference
+                                    / "sampleData" ":" ws ( "employees" / "tasks" / "products" / "projects" )
+                                    / "type" ":" ws string_like_value
+                                    / "tableOwner" ":" ws string_like_value
+                                    / "tableName" ":" ws string_like_value
+                                    / "includeRowidColumn" ":" ws boolean
+                                    / "whereClause" ":" ws multiline_string
+                                    / "graphOwner" ":" ws string_like_value
+                                    / "graphName" ":" ws string_like_value
+                                    / "matchClause" ":" ws multiline_string
+                                    / "columnsClause" ":" ws multiline_string
+                                    / "orderByClause" ":" ws multiline_string
+                                    / "restSource" ":" ws reference
+                                    / "jsonDualityView" ":" ws reference
+                                    / "jsonSource" ":" ws reference
+                                    / "list" ":" ws reference
+                                    / "breadcrumb" ":" ws reference
+                                    / "filteredRegion" ":" ws reference
+                                    / "pageItemsToSubmit" ":" ws array_of_string_like_value
+                                    / "optimizerHint" ":" ws string_like_value
+                                    / "useGenericColumnNames" ":" ws boolean
+                                    / "genericColumnCount" ":" ws number
+
+
+region_component_appearance         = indent "componentAppearance" ws "{" line_end region_component_appearance_property_line* indent "}" line_end
+region_component_appearance_property_line = indent region_component_appearance_property line_end
+region_component_appearance_property = "display" ":" ws string_like_value
+                                    / "layout" ":" ws ( "grid" / "float" / "horizontal" )
+                                    / "gridColumns" ":" ws ( "2" / "3" / "4" / "5" )
+                                    / "listTemplate" ":" ws reference
+                                    / "breadcrumbTemplate" ":" ws reference
+                                    / "cssClasses" ":" ws array_of_string_like_value
+                                    / "templateOptions" ":" ws array_of_string_like_value
+                                    / "templateType" ":" ws ( "theme" / "predefined" )
+                                    / "template" ":" ws ( "html" / "verticalReport" / "csv" / "xml" / reference )
+                                    / "customAttributes" ":" ws string_like_value
+                                    / "showNullValuesAs" ":" ws string_like_value
+                                    / "selectFirstRow" ":" ws boolean
+                                    / "fixedRowHeight" ":" ws boolean
+
 
 page_item                           = indent "pageItem" (required_ws component_id)? ws "(" line_end page_item_body_line* indent ")" line_end
 page_item_body_line                 = page_item_direct_property_line
@@ -270,9 +338,57 @@ process_group_block                 = process_execution
                                     / process_source
                                     / process_advanced
 
-process_source                      = "ERROR"
-process_execution                   = "ERROR"
-process_advanced                    = "ERROR"
+process_source                      = indent "source" ws "{" line_end process_source_property_line* indent "}" line_end
+process_source_property_line        = indent process_source_property line_end
+process_source_property             = "location" ":" ws ( "localDatabase" / "restEnabledSql" )
+                                    / "language" ":" ws ( "plsql" / "javaScript-mle" )
+                                    / "plsqlCode" ":" ws code_block
+                                    / "javaScriptCode" ":" ws code_block
+                                    / "remoteServer" ":" ws reference
+
+
+process_execution                   = indent "execution" ws "{" line_end process_execution_property_line* indent "}" line_end
+process_execution_property_line     = indent process_execution_property line_end
+process_execution_property          = "sequence" ":" ws number
+                                    / "point" ":" ws string_like_value
+                                    / "runProcess" ":" ws ( "oncePerSessionOrWhenReset" / "oncePerPageVisitDefault" )
+
+
+process_advanced                    = indent "advanced" ws "{" line_end process_advanced_property_line* indent "}" line_end
+process_advanced_property_line      = indent process_advanced_property line_end
+process_advanced_property           = "staticId" ":" ws string_like_value
+                                    / "executionMappingIdentifier" ":" ws string_like_value
+
+
+computation_a                       = indent "computation" (required_ws component_id)? ws "(" line_end computation_a_body_line* indent ")" line_end
+computation_a_body_line             = computation_a_direct_property_line
+                                    / computation_a_group_block
+computation_a_direct_property_line  = indent computation_a_direct_property line_end
+computation_a_direct_property       = "itemName" ":" ws string_like_value
+
+computation_a_group_block           = computation_a_execution
+                                    / computation_a_computation
+
+computation_a_execution             = indent "execution" ws "{" line_end computation_a_execution_property_line* indent "}" line_end
+computation_a_execution_property_line = indent computation_a_execution_property line_end
+computation_a_execution_property    = "sequence" ":" ws number
+                                    / "point" ":" ws ( "newSession" / "beforeHeader" / "afterHeader" / "beforeRegions" / "afterRegions" / "beforeFooter" / "afterFooter" / "afterSubmit" )
+
+computation_a_computation           = indent "computation" ws "{" line_end computation_a_computation_property_line* indent "}" line_end
+computation_a_computation_property_line = indent computation_a_computation_property line_end
+computation_a_computation_property  = "type" ":" ws ( "staticValue" / "item" / "sqlQuerySingleValue" / "sqlQueryMultipleValues" / "expression" / "functionBody" / "preference" )
+                                    / "staticValue" ":" ws string_like_value
+                                    / "sqlQuery" ":" ws multiline_string
+                                    / "computationProcessed" ":" ws ( "newSession" / "replaceExisting" / "addToExisting" / "raiseErrorOnReplace" / "replaceNullValues" )
+                                    / "language" ":" ws ( "sql" / "plsql" / "javaScript-mle" )
+                                    / "sqlExpression" ":" ws multiline_string
+                                    / "plsqlExpression" ":" ws multiline_string
+                                    / "javaScriptExpression" ":" ws multiline_string
+                                    / "plsqlFunctionBody" ":" ws multiline_string
+                                    / "javaScriptFunctionBody" ":" ws multiline_string
+                                    / "itemName" ":" ws string_like_value
+                                    / "preference" ":" ws string_like_value
+
 
 
 dynamic_action                      = indent "dynamicAction" (required_ws component_id)? ws "(" line_end dynamic_action_body_line* indent ")" line_end
@@ -359,9 +475,12 @@ action_c_execution_property         = "sequence" ":" ws number
                                     / "waitForResult" ":" ws boolean
 
 
+
+
+
 reference                       = "@" reference_character*
 component_id                    = string / identifier / number
-code_block                      = multiline_string
+code_block                      = nl? ws multiline_string
                                 / string_like_value
 multiline_string                = "```" ( any_character / nl )* "```"
 blank_lines                     = (ws nl)*
@@ -370,11 +489,14 @@ required_ws                     = ~r"[ \t]+"
 line_end                        = nl
 nl                              = "\n" / "\r\n"
 indent                          = ~r"[ \t]*"
-value                           = string / identifier / boolean / number / reference / multiline_string / array
+value                           = multiline_string / array / complex / boolean / number / reference / string / identifier
 array                           = array_of_value
 array_separator                 = required_ws / line_end indent
 array_of_value                  = "[" ( ws value ( array_separator value )* ws / line_end ( indent value line_end )? indent )? "]"
 array_of_string_like_value      = "[" (line_end indent string_like_value)+ line_end indent "]"
+complex                         = "{" line_end key_value_line* indent "}"
+key_value_line                  = indent key_value line_end
+key_value                       = identifier ":" ws value
 string_like_value               = ~r"[^\[\]\n\r]+"
 reference_character             = ~r"[A-Za-z0-9_/#-]*"
 string                          = ~r"\"[^\"]+\""

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/__init__.py

@@ -0,0 +1,59 @@
+from .base import ApexObject, ApexGroup
+
+from .action_c import (
+    ActionC,
+    ActionCAffectedElements,
+    ActionCExecution
+)
+from .button import (
+    Button,
+    ButtonAppearance,
+    ButtonBehavior,
+    ButtonLayout
+)
+from .dynamic_action import (
+    DynamicAction,
+    DynamicActionExecution,
+    DynamicActionClientSideCondition,
+    DynamicActionWhen
+)
+from .computation_a import (
+    ComputationA,
+    ComputationAExecution,
+    ComputationAComputation
+)
+from .page_item import (
+    PageItem, 
+    PageItemAdvanced, 
+    PageItemAppearance, 
+    PageItemLabel, 
+    PageItemLayout,
+    PageItemSecurity,
+    PageItemSessionState,
+    PageItemSettings,
+    PageItemValidation
+)
+from .process import (
+    Process, 
+    ProcessAdvanced, 
+    ProcessExecution, 
+    ProcessSource
+)
+from .region import (
+    Region, 
+    RegionAppearance, 
+    RegionLayout,
+    RegionAdvanced,
+    RegionComponentAppearance,
+    RegionImage,
+    RegionSource
+)
+from .page import (
+    Page, 
+    PageHelp, 
+    PageAppearance, 
+    PageAdvanced, 
+    PageCss, 
+    PageNavigation, 
+    PageSecurity
+)

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/action_c.py

@@ -0,0 +1,13 @@
+from . import ApexGroup, ApexObject
+
+
+class ActionCAffectedElements(ApexGroup):
+    pass
+
+class ActionCExecution(ApexGroup):
+    pass
+
+
+class ActionC(ApexObject):
+    pass
+

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/base.py

@@ -0,0 +1,49 @@
+class ApexGroup():
+    def __init__(self, initial_data={}):
+        self.properties = {}
+        self.properties.update(initial_data)
+
+    def __setitem__(self, key, value):
+        self.properties[key] = value
+    
+    def __getitem__(self, key):
+        return self.properties.get(key, None)
+
+    def get(self, key, default=None):
+        return self.properties.get(key, default)
+
+
+class ApexObject():
+    def __init__(self, component_id=None, initial_data={}):
+        self.component_id = component_id
+        self.properties = {}
+        self.properties.update(initial_data)
+        self.groups = {}
+        self.children = []
+
+    def __setitem__(self, key, value):
+        if isinstance(value, ApexGroup):
+            self.groups[key] = value
+        elif isinstance(value, ApexObject):
+            self.children[key] = value
+        else:
+            self.properties[key] = value
+    
+    def __getitem__(self, key):
+        if key in self.groups:
+            return self.groups.get(key, None)
+        elif key in self.children:
+            return self.children.get(key, None)
+        else:
+            return self.properties.get(key, None)
+    
+    def add_property(self, key, value):
+        self.properties[key] = value
+    
+    def add_group(self, key, value):
+        self.groups[key] = value
+
+    def add_child(self, child):
+        self.children.append(child)
+
+  

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/button.py

@@ -0,0 +1,42 @@
+from . import ApexGroup, ApexObject
+
+
+class ButtonLayout(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def sequence(self):
+        return self.properties.get('sequence', None)
+
+    @property
+    def region(self):
+        return self.properties.get('region', None)
+
+
+class ButtonAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+class ButtonBehavior(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+
+class Button(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def button_name(self):
+        return self.properties.get('buttonName', None)
+
+    @property
+    def label(self):
+        return self.properties.get('label', None)
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', ButtonLayout({}))
+

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/computation_a.py

@@ -0,0 +1,12 @@
+from . import ApexGroup, ApexObject
+
+
+class ComputationAExecution(ApexGroup):
+    pass
+
+class ComputationAComputation(ApexGroup):
+    pass
+
+class ComputationA(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/dynamic_action.py

@@ -0,0 +1,16 @@
+from . import ApexGroup, ApexObject
+
+
+class DynamicActionExecution(ApexGroup):
+    pass
+
+class DynamicActionWhen(ApexGroup):
+    pass
+
+class DynamicActionClientSideCondition(ApexGroup):
+    pass
+
+class DynamicAction(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+

python_oracle_apex-0.0.3/src/python_oracle_apex/objects/page.py

@@ -0,0 +1,91 @@
+from . import ApexGroup, ApexObject, Region, PageItem, Button, DynamicAction, Process
+
+class PageAppearance(ApexGroup):
+    pass
+
+class PageNavigation(ApexGroup):
+    pass
+
+class PageCss(ApexGroup):
+    pass
+
+class PageSecurity(ApexGroup):
+    pass
+
+class PageAdvanced(ApexGroup):
+    pass
+
+class PageHelp(ApexGroup):
+    @property
+    def helpText(self):
+        return self['helpText']
+
+class Page(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    def __str__(self):
+        return f"Page<#{self.page} name: {self.name}>"
+
+    @property
+    def page(self):
+        return self.properties.get('page', self.component_id)
+
+    @property
+    def name(self):
+        return self.properties.get('name', "<NONAME>")
+
+    @property
+    def title(self):
+        return self.properties['title']
+
+    @property
+    def alias(self):
+        return self.properties['alias']
+
+
+    @property
+    def appearance(self) -> PageAppearance:
+        return self.groups.get('appearance', None)
+
+    @appearance.setter
+    def appearance(self, value):
+        self.groups['appearance'] = value
+
+    @property
+    def help(self) -> PageHelp:
+        return self.groups.get('help', None)
+
+
+    @property
+    def regions(self) -> list[Region]:
+        return [x for x in self.children if isinstance(x, Region)]
+    
+    @property
+    def page_items(self):
+        return [x for x in self.children if isinstance(x, PageItem)]
+
+    @property
+    def buttons(self):
+        return [x for x in self.children if isinstance(x, Button)]
+
+    @property
+    def dynamic_actions(self):
+        return [x for x in self.children if isinstance(x, DynamicAction)]
+
+    @property
+    def processes(self):
+        return [x for x in self.children if isinstance(x, Process)]
+
+
+    def get_region(self, reference_or_name):
+        regions = [x for x in self.regions 
+                   if x.component_id==reference_or_name[1:] 
+                   or x.name==reference_or_name
+                   ]
+        if len(regions) == 1:
+            return regions[0]
+        elif len(regions) == 0:
+            return None
+
+        return regions