python-oracle-apex 0.0.0__py3-none-any.whl

python_oracle_apex/objects.py

@@ -0,0 +1,295 @@
+from pathlib import Path
+
+
+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)
+
+
+class RegionLayout(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def sequence(self):
+        return self.properties.get('sequence', None)
+
+    @property
+    def parentRegion(self):
+        return self.properties.get('parentRegion', None)
+
+class RegionAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+
+class Region(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def name(self):
+        return self.properties.get('name', None)
+
+    @property
+    def title(self):
+        return self.properties.get('title', None)
+
+    @property
+    def type(self):
+        return self.properties.get('type', None)
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', RegionLayout())
+
+    @property
+    def appearance(self):
+        return self.groups.get('appearance', RegionAppearance())
+    
+
+class PageItemLabel(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+    @property
+    def label(self):
+        return self.properties.get('label', None) 
+
+
+class PageItemSettings(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+
+class PageItemLayout(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 PageItemAppearance(ApexGroup):
+    def __init__(self, initial_data={}):
+        super().__init__(initial_data)
+
+class PageItemValidation(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemAdvanced(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemSessionState(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+class PageItemSecurity(ApexGroup):
+    def __init__(self, initial_data={}):
+            super().__init__(initial_data)
+
+
+class PageItem(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+    @property
+    def name(self):
+        return self.properties.get('name', self.component_id)
+
+    @property
+    def type(self):
+        return self.properties.get('type', None)
+
+
+    @property
+    def layout(self):
+        return self.groups.get('layout', PageItemLayout())
+
+    @property
+    def label(self):
+        return self.groups.get('label', PageItemLabel())
+    
+
+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({}))
+
+
+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)
+
+
+class ActionAffectedElements(ApexGroup):
+    pass
+
+class ActionExecution(ApexGroup):
+    pass
+
+
+class Action(ApexObject):
+    pass
+
+class Process(ApexObject):
+    def __init__(self, component_id=None, initial_data={}):
+        super().__init__(component_id, initial_data)
+
+
+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):
+        return self.groups.get('appearance', None)
+
+    @appearance.setter
+    def appearance(self, value):
+        self.groups['appearance'] = value
+
+    @property
+    def regions(self):
+        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

python_oracle_apex/reader.py

@@ -0,0 +1,189 @@
+from pathlib import Path
+from python_oracle_apex.objects import *
+import yaml
+
+"""
+Read YAML and transform to Page object.
+
+Property names will be translated to the names used in de APEX Lang spec. (version 26.1)
+"""
+
+def make_properties(mapper, data, section, object: ApexObject):
+    for field_src, field_dest in mapper.items():
+        if field_src in data[section]:
+            object.add_property(field_dest, data[section][field_src])
+
+def make_group(mapper, data):
+    d = {}
+    for k, v in data.items():
+        if k in mapper:
+            d[mapper[k]] = v
+        else:
+            raise AttributeError(f"Unknown property '{k}'")
+    return d
+
+
+def make_region_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'parent-region': 'parentRegion',
+        'slot': 'slot',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+        'column': 'column',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan'
+    }    
+    d = make_group(f, data)
+    return RegionLayout(d)
+
+
+
+def make_region_appearance(data):
+    f = {
+        'icon': 'icon',
+        'template': 'template',
+        'template-options': 'templateOptions',
+        'render-components': 'renderComponents',
+        'css-classes': 'cssClasses',
+    }    
+    d = make_group(f, data)
+    return RegionAppearance(d)
+
+
+def make_region(region):
+    r = Region(region['id'])
+    make_properties({
+                    'name': 'name',
+                    'title': 'title',
+                    'type': 'type'
+                }, 
+                region, 'identification', r
+                )
+
+    if 'layout' in region:
+        l = make_region_layout(region['layout'])
+        r.add_group('layout',  l)
+
+    if 'appearance' in region:
+        a = make_region_appearance(region['appearance'])
+        r.add_group('appearance', a)
+    return r
+
+
+def make_page_item_label(data):
+    f = {
+        'label': 'label',
+        'alignment': 'alignment',
+    }
+    d = make_group(f, data)
+    return PageItemLabel(d)
+
+def make_page_item_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'region': 'region',
+        'alignment': 'alignment',
+        'slot': 'slot',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+        'column': 'column',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan',
+        'label-column-span': 'labelColumnSpan',
+    }    
+    d = make_group(f, data)
+    return PageItemLayout(d)
+
+def make_page_item_appearance(data):
+    return {}
+
+
+def make_page_item(page_item):
+    p = PageItem(page_item['id'])
+    make_properties({
+                'name': 'name',
+                'type': 'type'
+            }, 
+            page_item, 'identification', p
+            )
+
+    if 'label' in page_item:
+        l = make_page_item_label(page_item['label'])
+        p.add_group('label',  l)
+        
+    if 'layout' in page_item:
+        l = make_page_item_layout(page_item['layout'])
+        p.add_group('layout',  l)
+
+    if 'appearance' in page_item:
+        a = make_page_item_appearance(page_item['appearance'])
+        p.add_group('appearance', a)
+    return p
+
+
+def make_button_layout(data):
+    f = {
+        'sequence': 'sequence',
+        'region': 'region',
+        'slot': 'slot',
+        'column': 'column',
+        'alignment': 'alignment',
+        'new-column': 'newColumn',
+        'column-span': 'columnSpan',
+        'start-new-layout': 'startNewLayout',
+        'start-new-row': 'startNewRow',
+
+    }
+    d = make_group(f, data)
+    return ButtonLayout(d)
+
+def make_button(data):
+    b = Button(data['id'])
+    make_properties({
+        'button-name': 'buttonName',
+        'label': 'label'
+    }, data, 'identification', b)
+
+    if 'layout' in data:
+        l = make_button_layout(data['layout'])
+        b.add_group('layout', l)
+
+    return b
+
+
+def parse_yaml_file(fn: Path) -> Page:
+
+    with open(fn, 'r') as f:
+        data = yaml.safe_load(f)
+
+    
+
+    page = Page(data['id'])
+    for field in ['name', 'alias', 'title']:
+        if field in data['identification']:
+            page.add_property(field, data['identification'][field])
+
+    for region in data['regions']:
+        r = make_region(region)
+        page.add_child(r)
+
+    for page_item in data['page-items']:
+        p = make_page_item(page_item)
+        page.add_child(p)
+
+    for button in data['buttons']:
+        b = make_button(button)
+        page.add_child(b)
+
+    return page
+
+
+if __name__ == '__main__':    # pragma: no cover
+
+    page = parse_yaml_file("examples/f300_page_9999.yaml")
+
+    for r in page.regions:
+        print(r.component_id, r.name, r.type)
+    
+    print(page)

python_oracle_apex-0.0.0.dist-info/METADATA

@@ -0,0 +1,27 @@
+Metadata-Version: 2.3
+Name: python-oracle-apex
+Version: 0.0.0
+Summary: Parsing files exported from Oracle APEX
+Author: Maurice Koster
+Author-email: Maurice Koster <maurice@mauricekoster.com>
+Requires-Dist: parsimonious>=0.11.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# python-oracle-apex
+Parsing an APEX lang export file into Objects
+
+## Oracle APEX
+
+## APEXLang - reading .apx files
+
+```python
+page = parse_apex("examples/login.apx")
+```
+
+## Reading yaml files, pre APEX 26.1
+
+```python
+page = parse_yaml("examples/login.yaml")
+```

python_oracle_apex-0.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+python_oracle_apex/__init__.py,sha256=hEpJLozpFV20dt_RRFi2FTdU4OfAfo2capAj3PG3OiQ,173
+python_oracle_apex/apexlang-26.1.peg,sha256=EpzBYDdKMndrqtIPgeRRl1jXGYY2ojaqs3JZ-mwkriU,27154
+python_oracle_apex/grammar.py,sha256=N6hBdDOn4UNclb1kuEpZqhwact6pArsxeGiNTHwi5xI,32909
+python_oracle_apex/objects.py,sha256=vq5NkBcXv_CuoEceBHdXz9PPgfoqN8Dxw4E7Di9s2sM,7285
+python_oracle_apex/reader.py,sha256=XXOCGylHdu8YxzHd-4J5G__KwTWCCwxG1PYaY-ROwi0,4673
+python_oracle_apex-0.0.0.dist-info/WHEEL,sha256=ZFFp7t7R4RYQ5KYZkmiFWoQvHay7SrTmn-6ZYfoFZ3U,80
+python_oracle_apex-0.0.0.dist-info/entry_points.txt,sha256=4hypeKGZzJvVbIPe-A7DX5T8X1nb_ORdnkz-CwhWRVU,64
+python_oracle_apex-0.0.0.dist-info/METADATA,sha256=y8BJj672MQ2wiZ-NfupikP7Uk1lwujiabHyyaVzm-ms,587
+python_oracle_apex-0.0.0.dist-info/RECORD,,

python_oracle_apex-0.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.12.7
+Root-Is-Purelib: true
+Tag: py3-none-any

python_oracle_apex-0.0.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+python-oracle-apex = python_oracle_apex:main
+