dash-seqviz 0.2.0__tar.gz → 0.2.2__tar.gz

{dash_seqviz-0.2.0/dash_seqviz.egg-info → dash_seqviz-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dash_seqviz
-Version: 0.2.0
+Version: 0.2.2
 Summary: A wrapper of the javascript DNA, RNA and protein sequence viewer
 Home-page: https://dash-seqviz.com
 Author: Evan Rees <evanroyrees@gmail.com>
@@ -128,7 +128,7 @@ if __name__ == '__main__':
 
 - **`colors`** (list): Array of colors for annotations, translations, and highlights.
 
-- **`bpColors`** (dict): Object mapping base pairs or indexes to custom colors.
+- **`bp_colors`** (dict): Object mapping base pairs or indexes to custom colors.
   - Example: `{"A": "#FF0000", "T": "#00FF00", 12: "#0000FF"}`
 
 - **`style`** (dict): CSS styles for the outer container div.
@@ -138,13 +138,13 @@ if __name__ == '__main__':
   - Format: `{"linear": int}` (0-100)
   - Default: `{"linear": 50}`
 
-- **`showComplement`** (bool): Whether to show the complement sequence.
+- **`show_complement`** (bool): Whether to show the complement sequence.
   - Default: `true`
 
-- **`rotateOnScroll`** (bool): Whether the circular viewer rotates on scroll.
+- **`rotate_on_scroll`** (bool): Whether the circular viewer rotates on scroll.
   - Default: `true`
 
-- **`disableExternalFonts`** (bool): Whether to disable downloading external fonts.
+- **`disable_external_fonts`** (bool): Whether to disable downloading external fonts.
   - Default: `false`
 
 - Deprecated (prefer parsing externally with `seqparse`):
@@ -152,8 +152,8 @@ if __name__ == '__main__':
   - **`accession`** (string): NCBI accession-ID
 
 - Events / Read-only:
-  - **`onSelection`** (function): Called after selection events; selection returned also via `selection`
-  - **`onSearch`** (function): Called after search; results returned also via `searchResults` (read-only)
+  - **`on_selection`** (function): Called after selection events; selection returned also via `selection`
+  - **`on_search`** (function): Called after search; results returned also via `search_results` (read-only)
 
 ## Examples
 

{dash_seqviz-0.2.0 → dash_seqviz-0.2.2}/README.md

@@ -84,7 +84,7 @@ if __name__ == '__main__':
 
 - **`colors`** (list): Array of colors for annotations, translations, and highlights.
 
-- **`bpColors`** (dict): Object mapping base pairs or indexes to custom colors.
+- **`bp_colors`** (dict): Object mapping base pairs or indexes to custom colors.
   - Example: `{"A": "#FF0000", "T": "#00FF00", 12: "#0000FF"}`
 
 - **`style`** (dict): CSS styles for the outer container div.
@@ -94,13 +94,13 @@ if __name__ == '__main__':
   - Format: `{"linear": int}` (0-100)
   - Default: `{"linear": 50}`
 
-- **`showComplement`** (bool): Whether to show the complement sequence.
+- **`show_complement`** (bool): Whether to show the complement sequence.
   - Default: `true`
 
-- **`rotateOnScroll`** (bool): Whether the circular viewer rotates on scroll.
+- **`rotate_on_scroll`** (bool): Whether the circular viewer rotates on scroll.
   - Default: `true`
 
-- **`disableExternalFonts`** (bool): Whether to disable downloading external fonts.
+- **`disable_external_fonts`** (bool): Whether to disable downloading external fonts.
   - Default: `false`
 
 - Deprecated (prefer parsing externally with `seqparse`):
@@ -108,8 +108,8 @@ if __name__ == '__main__':
   - **`accession`** (string): NCBI accession-ID
 
 - Events / Read-only:
-  - **`onSelection`** (function): Called after selection events; selection returned also via `selection`
-  - **`onSearch`** (function): Called after search; results returned also via `searchResults` (read-only)
+  - **`on_selection`** (function): Called after selection events; selection returned also via `selection`
+  - **`on_search`** (function): Called after search; results returned also via `search_results` (read-only)
 
 ## Examples
 

{dash_seqviz-0.2.0 → dash_seqviz-0.2.2}/dash_seqviz/SeqViz.py

@@ -44,18 +44,33 @@ Keyword arguments:
     - color (string; optional)
 
 - bpColors (dict; optional):
+    @deprecated since 0.2.2, use `bp_colors`. Removed in 0.3.0.
+
+- bp_colors (dict; optional):
     Object mapping base pairs or indexes to custom colors.
 
 - colors (list of strings; optional):
     Array of colors for annotations, translations, and highlights.
 
-- disableExternalFonts (boolean; default False):
+- disableExternalFonts (boolean; optional):
+    @deprecated since 0.2.2, use `disable_external_fonts`. Removed in
+    0.3.0.
+
+- disable_external_fonts (boolean; default False):
     Whether to disable downloading external fonts.
 
-- enableCopyEvent (boolean; default True):
+- enableCopyEvent (boolean; optional):
+    @deprecated since 0.2.2, use `enable_copy_event`. Removed in
+    0.3.0.
+
+- enableSelectAllEvent (boolean; optional):
+    @deprecated since 0.2.2, use `enable_select_all_event`. Removed in
+    0.3.0.
+
+- enable_copy_event (boolean; default True):
     When False, disables the default copyEvent (ctrl/cmd + C).
 
-- enableSelectAllEvent (boolean; default True):
+- enable_select_all_event (boolean; default True):
     When False, disables the default selectAllEvent (ctrl/cmd + A).
 
 - enzymes (list of dicts; optional):
@@ -114,7 +129,10 @@ Keyword arguments:
 
     - color (string; optional)
 
-- rotateOnScroll (boolean; default True):
+- rotateOnScroll (boolean; optional):
+    @deprecated since 0.2.2, use `rotate_on_scroll`. Removed in 0.3.0.
+
+- rotate_on_scroll (boolean; default True):
     Whether the circular viewer rotates on scroll.
 
 - search (dict; optional):
@@ -127,6 +145,9 @@ Keyword arguments:
     - mismatch (number; optional)
 
 - searchResults (list; optional):
+    @deprecated since 0.2.2, use `search_results`. Removed in 0.3.0.
+
+- search_results (list; optional):
     Search results emitted by seqviz (read-only for Dash usage).
 
 - selection (dict; optional):
@@ -144,7 +165,10 @@ Keyword arguments:
 - seq (string; optional):
     The sequence to render. Can be DNA, RNA, or amino acid sequence.
 
-- showComplement (boolean; default True):
+- showComplement (boolean; optional):
+    @deprecated since 0.2.2, use `show_complement`. Removed in 0.3.0.
+
+- show_complement (boolean; default True):
     Whether to show the complement sequence.
 
 - translations (list of dicts; optional):
@@ -279,22 +303,31 @@ Keyword arguments:
         search: typing.Optional["Search"] = None,
         selection: typing.Optional["Selection"] = None,
         colors: typing.Optional[typing.Sequence[str]] = None,
-        bpColors: typing.Optional[dict] = None,
+        bp_colors: typing.Optional[dict] = None,
         style: typing.Optional[typing.Any] = None,
         zoom: typing.Optional["Zoom"] = None,
+        show_complement: typing.Optional[bool] = None,
+        rotate_on_scroll: typing.Optional[bool] = None,
+        disable_external_fonts: typing.Optional[bool] = None,
+        on_selection: typing.Optional[typing.Any] = None,
+        on_search: typing.Optional[typing.Any] = None,
+        enable_copy_event: typing.Optional[bool] = None,
+        enable_select_all_event: typing.Optional[bool] = None,
+        search_results: typing.Optional[typing.Sequence] = None,
+        bpColors: typing.Optional[dict] = None,
         showComplement: typing.Optional[bool] = None,
         rotateOnScroll: typing.Optional[bool] = None,
         disableExternalFonts: typing.Optional[bool] = None,
-        onSelection: typing.Optional[typing.Any] = None,
-        onSearch: typing.Optional[typing.Any] = None,
         enableCopyEvent: typing.Optional[bool] = None,
         enableSelectAllEvent: typing.Optional[bool] = None,
+        onSelection: typing.Optional[typing.Any] = None,
+        onSearch: typing.Optional[typing.Any] = None,
         searchResults: typing.Optional[typing.Sequence] = None,
         **kwargs
     ):
-        self._prop_names = ['id', 'annotations', 'bpColors', 'colors', 'disableExternalFonts', 'enableCopyEvent', 'enableSelectAllEvent', 'enzymes', 'highlights', 'name', 'primers', 'rotateOnScroll', 'search', 'searchResults', 'selection', 'seq', 'showComplement', 'style', 'translations', 'viewer', 'zoom']
+        self._prop_names = ['id', 'annotations', 'bpColors', 'bp_colors', 'colors', 'disableExternalFonts', 'disable_external_fonts', 'enableCopyEvent', 'enableSelectAllEvent', 'enable_copy_event', 'enable_select_all_event', 'enzymes', 'highlights', 'name', 'primers', 'rotateOnScroll', 'rotate_on_scroll', 'search', 'searchResults', 'search_results', 'selection', 'seq', 'showComplement', 'show_complement', 'style', 'translations', 'viewer', 'zoom']
         self._valid_wildcard_attributes =            []
-        self.available_properties = ['id', 'annotations', 'bpColors', 'colors', 'disableExternalFonts', 'enableCopyEvent', 'enableSelectAllEvent', 'enzymes', 'highlights', 'name', 'primers', 'rotateOnScroll', 'search', 'searchResults', 'selection', 'seq', 'showComplement', 'style', 'translations', 'viewer', 'zoom']
+        self.available_properties = ['id', 'annotations', 'bpColors', 'bp_colors', 'colors', 'disableExternalFonts', 'disable_external_fonts', 'enableCopyEvent', 'enableSelectAllEvent', 'enable_copy_event', 'enable_select_all_event', 'enzymes', 'highlights', 'name', 'primers', 'rotateOnScroll', 'rotate_on_scroll', 'search', 'searchResults', 'search_results', 'selection', 'seq', 'showComplement', 'show_complement', 'style', 'translations', 'viewer', 'zoom']
         self.available_wildcard_properties =            []
         _explicit_args = kwargs.pop('_explicit_args')
         _locals = locals()

dash_seqviz-0.2.2/dash_seqviz/__init__.py

@@ -0,0 +1,110 @@
+import json
+import os as _os
+import sys as _sys
+import warnings as _warnings
+from pathlib import Path
+
+import dash as _dash
+
+from ._imports_ import SeqViz as _GeneratedSeqViz
+
+if not hasattr(_dash, 'development'):
+    print(
+        'Dash was not successfully imported. '
+        'Make sure you don\'t have a file '
+        'named \n"dash.py" in your current directory.',
+        file=_sys.stderr,
+    )
+    _sys.exit(1)
+
+_basepath = Path(__file__).parent
+with open(_basepath / 'package-info.json') as f:
+    package = json.load(f)
+
+package_name = package['name'].replace(' ', '_').replace('-', '_')
+__version__ = package['version']
+
+_async_resources = ["SeqViz"]
+
+_js_dist = [
+    {
+        "relative_package_path": f"async-{resource}.js",
+        "external_url": (
+            f"https://unpkg.com/{package_name}@{__version__}"
+            f"/{__name__}/async-{resource}.js"
+        ),
+        "namespace": package_name,
+        "async": True,
+    }
+    for resource in _async_resources
+] + [
+    {
+        "relative_package_path": f"async-{resource}.js.map",
+        "external_url": (
+            f"https://unpkg.com/{package_name}@{__version__}"
+            f"/{__name__}/async-{resource}.js.map"
+        ),
+        "namespace": package_name,
+        "dynamic": True,
+    }
+    for resource in _async_resources
+] + [
+    {
+        'relative_package_path': 'dash_seqviz.min.js',
+        'namespace': package_name,
+    },
+    {
+        'relative_package_path': 'dash_seqviz.min.js.map',
+        'namespace': package_name,
+        'dynamic': True,
+    },
+]
+
+_css_dist = []
+
+
+# Map of deprecated camelCase prop names to their snake_case replacements.
+# Removed in dash-seqviz 0.3.0.
+#
+# Note: the upstream `onSelection` / `onSearch` JS callbacks are documented as
+# props but Dash filters function-typed props out of the constructor at
+# runtime, so they are not in this map — they were never settable from Python.
+_DEPRECATED_PROPS = {
+    "bpColors": "bp_colors",
+    "showComplement": "show_complement",
+    "rotateOnScroll": "rotate_on_scroll",
+    "disableExternalFonts": "disable_external_fonts",
+    "enableCopyEvent": "enable_copy_event",
+    "enableSelectAllEvent": "enable_select_all_event",
+    "searchResults": "search_results",
+}
+
+
+class SeqViz(_GeneratedSeqViz):
+    """SeqViz Dash component.
+
+    Wraps the auto-generated component to emit ``DeprecationWarning`` when any
+    of the legacy camelCase props are used. The deprecated names continue to
+    work in 0.2.x and are removed in 0.3.0.
+
+    See the auto-generated parent class for the full prop reference.
+    """
+
+    def __init__(self, *args, **kwargs):
+        for _old, _new in _DEPRECATED_PROPS.items():
+            if _old in kwargs:
+                _warnings.warn(
+                    f"`{_old}` is deprecated since dash-seqviz 0.2.2 and will "
+                    f"be removed in 0.3.0. Use `{_new}` instead.",
+                    DeprecationWarning,
+                    stacklevel=2,
+                )
+                # snake_case wins on conflict
+                kwargs.setdefault(_new, kwargs.pop(_old))
+        super().__init__(*args, **kwargs)
+
+
+SeqViz._js_dist = _js_dist
+SeqViz._css_dist = _css_dist
+
+__all__ = ["SeqViz"]