pyside6-datatable-widget 1.0.0__tar.gz

pyside6_datatable_widget-1.0.0/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: pyside6-datatable-widget
+Version: 1.0.0
+Summary: A PySide6 DataTable widget with jQuery DataTable-like functionality
+Home-page: https://github.com/ultra-bugs/pyside6-datatable-widget
+Author: Zuko
+Author-email: tansautn@gmail.com
+Project-URL: Bug Tracker, https://github.com/ultra-bugs/pyside6-datatable-widget/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: User Interfaces
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: PySide6>=6.1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# PySide6 DataTable
+
+A powerful DataTable widget for PySide6 applications with functionality similar to jQuery DataTable.
+
+## Features
+
+- **Customizable Table**: Easily configure columns, types, and formatting
+- **Data Type Detection**: Automatically detect and handle different data types
+- **Type-based Sorting**: Different column types sort appropriately
+- **Search Functionality**: Global and column-specific search
+- **Row Collapsing**: Support for expandable/collapsible rows
+- **Pagination**: Built-in pagination with configurable page sizes
+- **Column Visibility**: Show/hide columns easily
+- **Aggregation Functions**: Calculate sums, averages, percentages, etc.
+- **Custom Formatting**: Format data display for different column types
+- **Observer Pattern**: Event-driven architecture for clear code organization
+
+## Installation
+
+```bash
+pip install pyside6-datatable-widget
+```
+
+## Basic Usage
+
+```python
+import sys
+from PySide6.QtWidgets import QApplication, QMainWindow, QVBoxLayout, QWidget
+from datatable import DataTable, DataType
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("DataTable Example")
+        self.resize(800, 600)
+        
+        # Create central widget and layout
+        central_widget = QWidget()
+        self.setCentralWidget(central_widget)
+        layout = QVBoxLayout(central_widget)
+        
+        # Create DataTable
+        self.data_table = DataTable()
+        layout.addWidget(self.data_table)
+        
+        # Set up columns (key, header, data_type)
+        columns = [
+            ("id", "ID", DataType.NUMERIC),
+            ("name", "Name", DataType.STRING),
+            ("age", "Age", DataType.NUMERIC),
+            ("active", "Active", DataType.BOOLEAN)
+        ]
+        
+        # Set up data
+        data = [
+            {"id": 1, "name": "John", "age": 30, "active": True},
+            {"id": 2, "name": "Jane", "age": 25, "active": False},
+            {"id": 3, "name": "Bob", "age": 40, "active": True}
+        ]
+        
+        # Apply to table
+        self.data_table.setColumns(columns)
+        self.data_table.setData(data)
+        
+        # Connect signals
+        self.data_table.rowSelected.connect(self.on_row_selected)
+        
+    def on_row_selected(self, row, row_data):
+        print(f"Row {row} selected: {row_data}")
+
+if __name__ == "__main__":
+    app = QApplication(sys.argv)
+    window = MainWindow()
+    window.show()
+    sys.exit(app.exec())
+```
+
+## Advanced Features
+
+### Custom Column Formatting
+
+```python
+from datatable import DataTableModel
+
+# Create model with custom formatting
+model = DataTableModel()
+model.setFormattingFunction("price", lambda value: f"${value:.2f}")
+model.setFormattingFunction("percentage", lambda value: f"{value:.1f}%")
+
+# Set model to table
+data_table.setModel(model)
+```
+
+### Row Collapsing
+
+```python
+# Enable row collapsing
+data_table.enableRowCollapsing(True, "subrows")
+
+# Example data with subrows
+data = [
+    {
+        "id": 1, 
+        "name": "Category A", 
+        "total": 1000,
+        "subrows": [
+            {"id": 101, "name": "Item A1", "total": 500},
+            {"id": 102, "name": "Item A2", "total": 500}
+        ]
+    },
+    {
+        "id": 2, 
+        "name": "Category B", 
+        "total": 2000,
+        "subrows": [
+            {"id": 201, "name": "Item B1", "total": 1200},
+            {"id": 202, "name": "Item B2", "total": 800}
+        ]
+    }
+]
+
+data_table.setData(data)
+
+# Connect expansion signals
+data_table.rowExpanded.connect(lambda row, data: print(f"Row {row} expanded"))
+data_table.rowCollapsed.connect(lambda row, data: print(f"Row {row} collapsed"))
+```
+
+### Aggregation Functions
+
+```python
+# Get aggregate values
+total = data_table.getAggregateValue("amount", "sum")
+average = data_table.getAggregateValue("amount", "avg")
+count = data_table.getAggregateValue("id", "count")
+
+# Calculate percentage of a row value relative to total
+row_data = data_table.getSelectedRow()
+if row_data:
+    amount = row_data["amount"]
+    total = data_table.getAggregateValue("amount", "sum")
+    percentage = data_table.calculateRowPercentage(row_index, "amount")
+```
+
+### Custom Search Functions
+
+```python
+# Set custom search function for a column
+model.setSearchFunction("complex_data", lambda value, term: term in str(value["name"]))
+
+# Search in table
+data_table.search("search term")
+
+# Search specific column
+matching_rows = model.searchColumn("name", "John")
+```
+
+## API Reference
+
+### DataTable
+
+Main widget class that provides the UI and functionality.
+
+#### Methods
+
+- `setData(data)`: Set table data
+- `setColumns(columns)`: Set table columns
+- `setVisibleColumns(columns)`: Set which columns are visible
+- `enableRowCollapsing(enabled, child_row_key)`: Enable/disable row collapsing
+- `search(term)`: Search the table
+- `sort(column_key, order)`: Sort the table
+- `setPage(page)`: Set current page
+- `setRowsPerPage(rows)`: Set rows per page
+- `getData()`: Get current table data
+- `getSelectedRow()`: Get selected row data
+- `getAggregateValue(column_key, agg_type)`: Get aggregate value for column
+
+#### Signals
+
+- `pageChanged(page)`: Emitted when page changes
+- `rowSelected(row, row_data)`: Emitted when row is selected
+- `rowExpanded(row, row_data)`: Emitted when row is expanded
+- `rowCollapsed(row, row_data)`: Emitted when row is collapsed
+- `dataFiltered(rows)`: Emitted when data is filtered
+- `sortChanged(column, order)`: Emitted when sort order changes
+
+### DataTableModel
+
+Model class that manages data and operations.
+
+#### Methods
+
+- `setData(data)`: Set model data
+- `setColumns(columns)`: Set model columns
+- `setFormattingFunction(column_key, func)`: Set formatting function
+- `setEditableColumns(editable_columns)`: Set which columns are editable
+- `setVisibleColumns(visible_columns)`: Set which columns are visible
+- `setSearchFunction(column_key, func)`: Set search function
+- `setSortFunction(column_key, func)`: Set sort function
+- `setAggregationFunction(column_key, agg_type, func)`: Set aggregation function
+- `enableRowCollapsing(enabled, child_row_key)`: Enable row collapsing
+- `search(term)`: Search all rows
+- `searchColumn(column_key, term)`: Search specific column
+- `aggregate(column_key, agg_type)`: Aggregate column values
+- `calculateRowPercentage(row_index, column_key)`: Calculate row percentage
+
+## License
+
+MIT

pyside6_datatable_widget-1.0.0/README.md

@@ -0,0 +1,209 @@
+# PySide6 DataTable
+
+A powerful DataTable widget for PySide6 applications with functionality similar to jQuery DataTable.
+
+## Features
+
+- **Customizable Table**: Easily configure columns, types, and formatting
+- **Data Type Detection**: Automatically detect and handle different data types
+- **Type-based Sorting**: Different column types sort appropriately
+- **Search Functionality**: Global and column-specific search
+- **Row Collapsing**: Support for expandable/collapsible rows
+- **Pagination**: Built-in pagination with configurable page sizes
+- **Column Visibility**: Show/hide columns easily
+- **Aggregation Functions**: Calculate sums, averages, percentages, etc.
+- **Custom Formatting**: Format data display for different column types
+- **Observer Pattern**: Event-driven architecture for clear code organization
+
+## Installation
+
+```bash
+pip install pyside6-datatable-widget
+```
+
+## Basic Usage
+
+```python
+import sys
+from PySide6.QtWidgets import QApplication, QMainWindow, QVBoxLayout, QWidget
+from datatable import DataTable, DataType
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("DataTable Example")
+        self.resize(800, 600)
+        
+        # Create central widget and layout
+        central_widget = QWidget()
+        self.setCentralWidget(central_widget)
+        layout = QVBoxLayout(central_widget)
+        
+        # Create DataTable
+        self.data_table = DataTable()
+        layout.addWidget(self.data_table)
+        
+        # Set up columns (key, header, data_type)
+        columns = [
+            ("id", "ID", DataType.NUMERIC),
+            ("name", "Name", DataType.STRING),
+            ("age", "Age", DataType.NUMERIC),
+            ("active", "Active", DataType.BOOLEAN)
+        ]
+        
+        # Set up data
+        data = [
+            {"id": 1, "name": "John", "age": 30, "active": True},
+            {"id": 2, "name": "Jane", "age": 25, "active": False},
+            {"id": 3, "name": "Bob", "age": 40, "active": True}
+        ]
+        
+        # Apply to table
+        self.data_table.setColumns(columns)
+        self.data_table.setData(data)
+        
+        # Connect signals
+        self.data_table.rowSelected.connect(self.on_row_selected)
+        
+    def on_row_selected(self, row, row_data):
+        print(f"Row {row} selected: {row_data}")
+
+if __name__ == "__main__":
+    app = QApplication(sys.argv)
+    window = MainWindow()
+    window.show()
+    sys.exit(app.exec())
+```
+
+## Advanced Features
+
+### Custom Column Formatting
+
+```python
+from datatable import DataTableModel
+
+# Create model with custom formatting
+model = DataTableModel()
+model.setFormattingFunction("price", lambda value: f"${value:.2f}")
+model.setFormattingFunction("percentage", lambda value: f"{value:.1f}%")
+
+# Set model to table
+data_table.setModel(model)
+```
+
+### Row Collapsing
+
+```python
+# Enable row collapsing
+data_table.enableRowCollapsing(True, "subrows")
+
+# Example data with subrows
+data = [
+    {
+        "id": 1, 
+        "name": "Category A", 
+        "total": 1000,
+        "subrows": [
+            {"id": 101, "name": "Item A1", "total": 500},
+            {"id": 102, "name": "Item A2", "total": 500}
+        ]
+    },
+    {
+        "id": 2, 
+        "name": "Category B", 
+        "total": 2000,
+        "subrows": [
+            {"id": 201, "name": "Item B1", "total": 1200},
+            {"id": 202, "name": "Item B2", "total": 800}
+        ]
+    }
+]
+
+data_table.setData(data)
+
+# Connect expansion signals
+data_table.rowExpanded.connect(lambda row, data: print(f"Row {row} expanded"))
+data_table.rowCollapsed.connect(lambda row, data: print(f"Row {row} collapsed"))
+```
+
+### Aggregation Functions
+
+```python
+# Get aggregate values
+total = data_table.getAggregateValue("amount", "sum")
+average = data_table.getAggregateValue("amount", "avg")
+count = data_table.getAggregateValue("id", "count")
+
+# Calculate percentage of a row value relative to total
+row_data = data_table.getSelectedRow()
+if row_data:
+    amount = row_data["amount"]
+    total = data_table.getAggregateValue("amount", "sum")
+    percentage = data_table.calculateRowPercentage(row_index, "amount")
+```
+
+### Custom Search Functions
+
+```python
+# Set custom search function for a column
+model.setSearchFunction("complex_data", lambda value, term: term in str(value["name"]))
+
+# Search in table
+data_table.search("search term")
+
+# Search specific column
+matching_rows = model.searchColumn("name", "John")
+```
+
+## API Reference
+
+### DataTable
+
+Main widget class that provides the UI and functionality.
+
+#### Methods
+
+- `setData(data)`: Set table data
+- `setColumns(columns)`: Set table columns
+- `setVisibleColumns(columns)`: Set which columns are visible
+- `enableRowCollapsing(enabled, child_row_key)`: Enable/disable row collapsing
+- `search(term)`: Search the table
+- `sort(column_key, order)`: Sort the table
+- `setPage(page)`: Set current page
+- `setRowsPerPage(rows)`: Set rows per page
+- `getData()`: Get current table data
+- `getSelectedRow()`: Get selected row data
+- `getAggregateValue(column_key, agg_type)`: Get aggregate value for column
+
+#### Signals
+
+- `pageChanged(page)`: Emitted when page changes
+- `rowSelected(row, row_data)`: Emitted when row is selected
+- `rowExpanded(row, row_data)`: Emitted when row is expanded
+- `rowCollapsed(row, row_data)`: Emitted when row is collapsed
+- `dataFiltered(rows)`: Emitted when data is filtered
+- `sortChanged(column, order)`: Emitted when sort order changes
+
+### DataTableModel
+
+Model class that manages data and operations.
+
+#### Methods
+
+- `setData(data)`: Set model data
+- `setColumns(columns)`: Set model columns
+- `setFormattingFunction(column_key, func)`: Set formatting function
+- `setEditableColumns(editable_columns)`: Set which columns are editable
+- `setVisibleColumns(visible_columns)`: Set which columns are visible
+- `setSearchFunction(column_key, func)`: Set search function
+- `setSortFunction(column_key, func)`: Set sort function
+- `setAggregationFunction(column_key, agg_type, func)`: Set aggregation function
+- `enableRowCollapsing(enabled, child_row_key)`: Enable row collapsing
+- `search(term)`: Search all rows
+- `searchColumn(column_key, term)`: Search specific column
+- `aggregate(column_key, agg_type)`: Aggregate column values
+- `calculateRowPercentage(row_index, column_key)`: Calculate row percentage
+
+## License
+
+MIT

pyside6_datatable_widget-1.0.0/datatable/__init__.py

@@ -0,0 +1,30 @@
+#              M""""""""`M            dP
+#              Mmmmmm   .M            88
+#              MMMMP  .MMM  dP    dP  88  .dP   .d8888b.
+#              MMP  .MMMMM  88    88  88888"    88'  `88
+#              M' .MMMMMMM  88.  .88  88  `8b.  88.  .88
+#              M         M  `88888P'  dP   `YP  `88888P'
+#              MMMMMMMMMMM    -*-  Created by Zuko  -*-
+#
+#              * * * * * * * * * * * * * * * * * * * * *
+#              * -    - -   F.R.E.E.M.I.N.D   - -    - *
+#              * -  Copyright © 2025 (Z) Programing  - *
+#              *    -  -  All Rights Reserved  -  -    *
+#              * * * * * * * * * * * * * * * * * * * * *
+
+from .widgets.datatable import DataTable
+from .models.datatable_model import DataTableModel, DataType, SortOrder
+from .models.delegates import CellDelegate, NumericDelegate, DateDelegate, BooleanDelegate
+
+__version__ = '1.0.0'
+
+__all__ = [
+    'DataTable',
+    'DataTableModel',
+    'DataType',
+    'SortOrder',
+    'CellDelegate',
+    'NumericDelegate',
+    'DateDelegate',
+    'BooleanDelegate',
+]

pyside6_datatable_widget-1.0.0/datatable/core/__init__.py

@@ -0,0 +1,18 @@
+#              M""""""""`M            dP
+#              Mmmmmm   .M            88
+#              MMMMP  .MMM  dP    dP  88  .dP   .d8888b.
+#              MMP  .MMMMM  88    88  88888"    88'  `88
+#              M' .MMMMMMM  88.  .88  88  `8b.  88.  .88
+#              M         M  `88888P'  dP   `YP  `88888P'
+#              MMMMMMMMMMM    -*-  Created by Zuko  -*-
+#
+#              * * * * * * * * * * * * * * * * * * * * *
+#              * -    - -   F.R.E.E.M.I.N.D   - -    - *
+#              * -  Copyright © 2025 (Z) Programing  - *
+#              *    -  -  All Rights Reserved  -  -    *
+#              * * * * * * * * * * * * * * * * * * * * *
+
+from .observer import Publisher, Subscriber, singleton
+from .widget_manager import WidgetManager
+
+__all__ = ['Publisher', 'Subscriber', 'singleton', 'WidgetManager']

pyside6_datatable_widget-1.0.0/datatable/core/base_controller.py

@@ -0,0 +1,116 @@
+#              M""""""""`M            dP
+#              Mmmmmm   .M            88
+#              MMMMP  .MMM  dP    dP  88  .dP   .d8888b.
+#              MMP  .MMMMM  88    88  88888"    88'  `88
+#              M' .MMMMMMM  88.  .88  88  `8b.  88.  .88
+#              M         M  `88888P'  dP   `YP  `88888P'
+#              MMMMMMMMMMM    -*-  Created by Zuko  -*-
+#
+#              * * * * * * * * * * * * * * * * * * * * *
+#              * -    - -   F.R.E.E.M.I.N.D   - -    - *
+#              * -  Copyright © 2025 (Z) Programing  - *
+#              *    -  -  All Rights Reserved  -  -    *
+#              * * * * * * * * * * * * * * * * * * * * *
+
+import importlib
+from abc import ABC, abstractmethod
+from typing import Dict, List, Any
+
+from PySide6.QtWidgets import QWidget
+
+from .observer import Publisher
+from .widget_manager import WidgetManager
+
+
+class ControllerMeta(type(QWidget), type(ABC)):
+    required_attrs = ['slot_map']
+
+    def __new__(cls, name, bases, dct):
+        required_attrs = cls.required_attrs
+        for attr in required_attrs:
+            if attr not in dct:
+                raise ValueError(f'Attribute: {attr} is required but not defined in {name}')
+        return super().__new__(cls, name, bases, dct)
+
+
+class BaseController(QWidget, ABC, metaclass=ControllerMeta):
+    """Base class for all controllers in datatable package"""
+
+    slot_map: Dict[str, List[str]] = {}
+    signal_connected = False
+    is_auto_connect_signal = True
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.widget_manager = WidgetManager(self)
+        self.controller_name = self.__class__.__name__
+        self.publisher = Publisher()
+        self.handler = None
+
+        # Setup UI
+        self.setupUi(self)
+
+        if not self.is_auto_connect_signal:
+            return
+
+        # Auto-loading handler
+        module_path = self.__module__
+        module_parts = module_path.split('.')
+        if len(module_parts) > 1:
+            # Try to find handler in the same package
+            base_module = '.'.join(module_parts[:-1])
+            handler_module_name = f'{base_module}.handlers.{self.controller_name}Handler'
+            print(handler_module_name)
+            try:
+                handler_module = importlib.import_module(handler_module_name)
+                handler_class = getattr(handler_module, f'{self.controller_name}Handler')
+                self.handler = handler_class(
+                    widget_manager=self.widget_manager, events=list(self.slot_map.keys())
+                )
+            except (ImportError, AttributeError):
+                # If not found, try alternative locations
+                pass
+
+        if self.is_auto_connect_signal and self.handler:
+            self._connect_signals()
+
+    @abstractmethod
+    def setupUi(self, widget):
+        """Set up the UI components"""
+        pass
+
+    def _connect_signals(self):
+        """Connect signals to slots based on slot_map"""
+        if not hasattr(self, 'slot_map'):
+            raise ValueError(
+                f'{self.__class__.__name__} must define slot_map to use auto connect signals'
+            )
+
+        subscriber = self.handler
+        for event in self.handler.events:
+            if event in self.slot_map:
+                signal_info = self.slot_map.get(event)
+                if signal_info is None:
+                    continue
+
+                if callable(signal_info):
+                    signal_info(self.handler, self.publisher)
+                    continue
+
+                try:
+                    widget = self.widget_manager.get(signal_info[0])
+                    self.publisher.connect(
+                        widget,
+                        signal_info[1],
+                        event,
+                        data={'widget': widget},
+                    )
+                    print(f'Connected {signal_info[1]} signal to {event} event')
+                    print(widget, event, signal_info)
+                except (AttributeError, Exception) as e:
+                    print(f'Error connecting signal: {e}')
+                    continue
+
+                self.publisher.subscribe(subscriber=subscriber, event=event)
+
+        self.signal_connected = True