PyDIET 0.9.3__py3-none-any.whl

pydiet/server/types/string.py

@@ -0,0 +1,318 @@
+"""
+Provide Pydantic-compatible annotations and annotated types for enhanced string
+validation and serialization.
+"""
+# Copyright UParisSaclay/CEA/CFHT/CNRS
+# Licensed under the MIT licence
+
+from __future__ import annotations
+
+from re import compile
+from typing import TYPE_CHECKING, Annotated, Any, Pattern
+
+if TYPE_CHECKING:
+    from pydantic import GetCoreSchemaHandler
+from pydantic import Field
+from pydantic_core import core_schema
+
+
+
+class StrAnnotation:
+    """
+    Pydantic compatible annotation for validating and serializing strings
+    (the original Pydantic 2.x string fields only support Rust Regex).
+
+    Examples
+    --------
+    >>> from typing import Annotated
+    >>> from pydantic import BaseModel
+    >>> from .string import StrAnnotation
+
+    >>> class Person(BaseModel):
+    ...     firstname: Annotated[str, StrAnnotation(pattern=r"[A-Z][a-z]*")]
+    ...     lastname: Annotated[str, StrAnnotation(pattern=r"[A-Z][a-z]*")]
+
+    >>> # The following instantiation validates
+    >>> user = Person(firstname="Emmanuel", lastname="Bertin")
+
+    >>> # The following instantiation does not validate
+    >>> user = Person(firstname="emmanuel", lastname="Bertin")
+    Traceback (most recent call last):
+    ...
+    pydantic_core._pydantic_core.ValidationError: 1 validation error for Person
+    firstname
+    Value error, string does not match [A-Z][a-z]* pattern
+    [type=value_error, input_value='emmanuel', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.8/v/value_error
+
+    Parameters
+    ----------
+    description: str, optional
+        Description string.
+    min_length: int, optional
+        Minimum string length.
+    max_length: int, optional
+        Maximum string length.
+    pattern: Pattern, optional
+        Regular expression for validation.
+    valid_list: list[str], optional
+        List of validating strings.
+    """
+    description: str = ""
+    min_length: int | None = None
+    max_length: int | None = None
+    pattern: Pattern | None = None
+    valid_list: list[str] | None = None
+    def __init__(
+            self,
+            *,
+            description: str = "",
+            min_length: int | None = None,
+            max_length: int | None = None,
+            pattern: Pattern | None = None,
+            valid_list: list[str] | None = None):
+
+        self.description = description
+        self.min_length = min_length
+        self.max_length = max_length
+        self.pattern = pattern
+        if pattern is not None:
+            self.compiled = compile(pattern)
+        self.valid_list = valid_list
+
+
+    def validate(
+            self,
+            s: str,
+            info: core_schema.ValidationInfo | None = None) -> str:
+
+        """
+        Validate `str`.
+
+        Parameters
+        ----------
+        s: str
+            String that should be validated.
+        info: ~pydantic.core_schema.ValidationInfo, optional
+            The validation info provided by the Pydantic schema.
+
+        Returns
+        -------
+        s: str
+            Validated string.
+
+        Raises
+        ------
+        ValueError: exception
+            An error occurred validating the specified string.
+            It is raised if any of the following occur:
+            - the provided string did not match the pattern.
+            - An unknown type was provided for the string.
+        """
+        # Check if it is a string
+        if not isinstance(s, str):
+            raise ValueError("not a string")
+
+        # Check if it has the right size
+        if self.min_length and len(s) < self.min_length:
+             raise ValueError(f"String should have at least {self.min_length} characters")
+        if self.max_length and len(s) > self.max_length:
+             raise ValueError(f"String should have at most {self.max_length} characters")
+
+        # Check if it matches the regular expression if provided
+        if self.pattern and not self.compiled.match(s):
+             raise ValueError(f"String should match {self.pattern} pattern")
+
+        # Check if it matches any member of the list if provided
+        if self.valid_list and not s in self.valid_list:
+             raise ValueError(f"String should match any of {self.valid_list}")
+
+        return s
+
+
+    def serialize(
+            self,
+            s: str,
+            info: core_schema.SerializationInfo | None = None,
+            *,
+            to_json: bool = False) -> dict | str:
+        """
+        Serialize string.
+
+        Parameters
+        ----------
+        s: str
+            String that should be serialized.
+        info: pydantic.core_schema.SerializationInfo, optional
+            Serialization info provided by the Pydantic schema.
+        to_json: bool, optional
+            Whether or not to serialize to a json convertible object.
+
+        Returns
+        -------
+        s: str
+            The serialized `str`.
+        """
+        return s
+
+
+    def __get_pydantic_core_schema__(
+            self,
+            source_type: Any,
+            handler: GetCoreSchemaHandler) -> core_schema.CoreSchema:
+        """
+        Get the Pydantic core schema.
+
+        Parameters
+        ----------
+        source_type:
+            The source type.
+        handler: ~pydantic.GetCoreSchemaHandler
+            The `GetCoreSchemaHandler` instance.
+
+        Returns
+        -------
+            The Pydantic core schema.
+        """
+        _from_typedict_schema = {
+            "value": core_schema.typed_dict_field(
+                core_schema.str_schema()
+            ),
+            "str": core_schema.typed_dict_field(core_schema.str_schema()),
+        }
+
+        validate_schema = core_schema.chain_schema(
+            [
+                core_schema.union_schema(
+                    [
+                        core_schema.is_instance_schema(str),
+                        core_schema.str_schema(
+                            min_length=self.min_length,
+                            max_length=self.max_length,
+                            pattern=self.pattern
+                        )
+                    ]
+                ),
+                core_schema.with_info_plain_validator_function(self.validate),
+            ]
+        )
+
+        validate_json_schema = core_schema.chain_schema(
+            [
+                core_schema.str_schema(
+                    min_length=self.min_length,
+                    max_length=self.max_length,
+                    pattern=self.pattern
+                ),
+                core_schema.no_info_plain_validator_function(self.validate)
+            ]
+        )
+
+        serialize_schema = core_schema.plain_serializer_function_ser_schema(
+            self.serialize,
+            info_arg=True,
+        )
+
+        return core_schema.json_or_python_schema(
+            json_schema=validate_json_schema,
+            python_schema=validate_schema,
+            serialization=serialize_schema,
+        )
+
+
+
+def AnnotatedStr(
+    default: str,
+    short: str | None = None,
+    description: str = "",
+    min_length: int | None = None,
+    max_length: int | None = None,
+    pattern: Pattern | None = None,
+    valid_list: list[str] | None = None) -> Any:
+    """
+    Pydantic pseudo-field for validating and serializing strings
+    (the original Pydantic 2.x string fields only support Rust Regex).
+
+    Examples
+    --------
+    >>> from pydantic_settings import BaseSettings
+    >>> from .string import AnnotatedStr
+
+    >>> class Person(BaseSettings):
+    ...     firstname: AnnotatedStr(
+    ...         short='f',
+    ...         description="First name.",
+    ...         default="Unknown",
+    ...         min_length=1,
+    ...         pattern=r"[A-Z][a-z]*"
+    ...     )
+    ...     lastname: AnnotatedStr(
+    ...        short='l',
+    ...        description="Last name.",
+    ...        default="Unknown",
+    ...        min_length=1,
+    ...        pattern=r"[A-Z][a-z]*"
+    ...    )
+
+    >>> # The following instantiation validates
+    >>> user = Person(firstname="Emmanuel", lastname="Bertin")
+
+    >>> # The following instantiation does not validate
+    user = Person(firstname="emmanuel", lastname="Bertin")
+    Traceback (most recent call last):
+    ...
+    pydantic_core._pydantic_core.ValidationError: 1 validation error for Person
+    firstname
+    Value error, string does not match [A-Z][a-z]* pattern
+    [type=value_error, input_value='emmanuel', input_type=str]
+    For further information visit https://errors.pydantic.dev/2.8/v/value_error
+
+    Parameters
+    ----------
+    default: str | ~astropy.units.Quantity
+        Default value
+    short: str, optional
+        shortcut for keyword
+    description: str, optional
+        Description string.
+    min_length: int, optional
+        Minimum string length.
+    max_length: int, optional
+        Maximum string length.
+    pattern: Pattern, optional
+        Regular expression for validation.
+    valid_list: list[str], optional
+        List of validating strings.
+    """
+
+    json_extra: dict = {}
+    if default is not None:
+        json_extra['default'] = default
+    if max_length is not None:
+        json_extra['maxLength'] = str(max_length)
+    if min_length is not None:
+        json_extra['minLength'] = str(min_length)
+    if pattern is not None:
+        json_extra['pattern'] = str(pattern)
+    if valid_list is not None:
+        json_extra['valid_list'] = valid_list
+    if short:
+        json_extra['short'] = short
+    return Annotated[
+        str,
+        StrAnnotation(
+            min_length=min_length,
+            max_length=max_length,
+            pattern=pattern,
+            valid_list=valid_list
+        ),
+        Field(
+            default_factory=lambda: default,
+            description=description,
+            validate_default=True,
+            json_schema_extra=json_extra
+        )        
+    ]
+
+
+

pydiet/templates/common/base.html

@@ -0,0 +1,80 @@
+{#
+# Base Jinja2 template for PyDIET client.
+#
+# Copyright CFHT/CNRS/OSUPS/CEA/UParisSaclay
+# Licensed under the MIT licence
+#}<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta id="root_path" content="{{ root_path }}">
+    <link rel="icon" type="image/svg+xml" href="{{ root_path }}/client/images/logo.svg">
+    <title>{{ package.summary }}</title>
+    <script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core/dist/ionic/ionic.esm.js"></script>
+    <script nomodule src="https://cdn.jsdelivr.net/npm/@ionic/core/dist/ionic/ionic.js"></script>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core/css/ionic.bundle.css" />
+    <link rel="stylesheet" href="{{ root_path }}/client/css/style.css" />
+    {% block headcontent %}{% endblock headcontent %}
+  </head>
+  <body>
+    <ion-app>
+      <ion-header>
+        <ion-toolbar>
+          <ion-menu-button slot="start"><ion-icon name="options"></ion-icon></ion-menu-button>
+          <ion-title size="large">
+            <ion-item lines="none">
+               <h3 style="width:100%; display:flex; justify-content:space-between; align-items: baseline;">
+                 <span>DIET</span>
+                 <span style="font-size: 0.75rem; color: var(--ion-color-medium);">v{{ package.version }}</span>
+               </h3>
+            </ion-item>
+          </ion-title>
+          <div id=user-slot slot="end"></div>
+        </ion-toolbar>
+      </ion-header>
+      <ion-menu side="start" content-id="main-content" style="--min-width:20rem;">
+        {% include "common/settings.html" %}
+        <ion-footer-bar>
+          <ion-item-divider>
+          </ion-item-divider>
+          <ion-item href="{{ root_path ~ doc_url }}" rel="external" target="_blank">
+            <ion-icon name="book" slot="start"></ion-icon>
+            <ion-label>Documentation</ion-label>
+          </ion-item>
+          <ion-item href="{{ root_path }}/docs" rel="external" target="_blank">
+            <ion-icon name="code-slash" slot="start"></ion-icon>
+            <ion-label>Web API</ion-label>
+          </ion-item>
+        </ion-footer-bar>
+      </ion-menu>
+      <ion-content id="main-content">
+        <div id="content-slot"></div>
+        <div id="modal-slot"></div>
+      </ion-content>
+      <ion-footer>
+        <ion-toolbar >
+          <ion-item lines="none" slot="start">
+             <ion-note id="terms" style="align-self:center; cursor:pointer">Terms of Service</ion-note>
+          </ion-item>
+          <ion-fab horizontal="center" vertical="center">
+            <ion-fab-button href="https://cfht.hawaii.edu" color="light" size="small">
+              <ion-icon src="{{ root_path }}/client/images/logo.svg"></ion-icon>
+            </ion-fab-button>
+          </ion-fab>
+          <ion-item lines="none" slot="end">
+            <ion-note id="privacy" style="align-self:center; cursor:pointer">Privacy Policy</ion-note>
+          </ion-item>
+        </ion-toolbar>
+      </ion-footer>
+      <ion-modal trigger="terms">
+        {% include "common/terms.html" %}
+      </ion-modal>
+      <ion-modal trigger="privacy">
+        {% include "common/privacy.html" %}
+      </ion-modal>
+    </ion-app>
+    <script src="{{ root_path }}/client/dist/pydiet.js"></script>
+  </body>
+</html>
+

pydiet/templates/common/plot_filter.html

@@ -0,0 +1,17 @@
+{#
+# Jinja2 template for plotting PyDIET filter curves.
+#
+# Copyright 2024,2025 CFHT/CNRS/OSUPS/CEA/UParisSaclay
+# Licensed under the MIT licence
+#}
+<ion-modal is-open=true backdrop-dismiss=true style="--height:auto;">
+  <ion-card>
+    <ion-card-header>
+      <ion-card-title>Instrument+telescope transmission curve</ion-card-title>
+    </ion-card-header>
+    <ion-card-content>
+      <canvas id="filter-canvas" />
+    </ion-card-content>
+  </ion-card>
+</ion-modal>
+

pydiet/templates/common/privacy.html

@@ -0,0 +1,132 @@
+  <ion-content class="ion-padding">
+    <ion-text color="medium">
+        <section class="privacy-policy">
+          <h1>Privacy Policy</h1>
+          <p><em>Last updated: March 17, 2026</em></p>
+
+          <p>
+            This Privacy Policy describes how <strong>PyDIET</strong>
+            (“the Service”), operated by <a href="https://www.cfht.hawaii.edu"><strong>CFHT</strong></a>, a
+            U.S.-based non-profit research organization, collects and uses information
+            when you access or use the Service.
+          </p>
+
+          <h2>1. Scope of the Service</h2>
+          <p>
+            The Service is an academic web-based exposure time calculator accessible
+            worldwide. It does not require user accounts or authentication.
+          </p>
+
+          <h2>2. Information We Collect</h2>
+
+          <h3>a. Information you provide</h3>
+          <p>
+            The Service does not require or collect personal information such as names,
+            email addresses, or account credentials.
+          </p>
+
+          <h3>b. Automatically collected information</h3>
+          <p>
+            When you access the Service, our servers may automatically record limited
+            technical information in standard server logs, including:
+          </p>
+          <ul>
+            <li>IP address</li>
+            <li>Date and time of requests</li>
+            <li>Requested URLs and query parameters</li>
+            <li>HTTP method (GET/POST)</li>
+            <li>User agent (browser or client information)</li>
+          </ul>
+          <p>
+            This information is collected solely for operational, security, and
+            debugging purposes.
+          </p>
+
+          <h3>c. Local storage</h3>
+          <p>
+            The Service may use your browser’s local storage to save application
+            settings, such as preferences. This data remains on your device and is not
+            transmitted to our servers.
+          </p>
+
+          <h2>3. Use of Information</h2>
+          <p>We use the limited data we collect to:</p>
+          <ul>
+            <li>Operate and maintain the Service</li>
+            <li>Monitor performance and ensure security</li>
+            <li>Diagnose technical issues and improve functionality</li>
+          </ul>
+          <p>
+            We do not use your data for profiling, advertising, or marketing purposes.
+          </p>
+
+          <h2>4. Legal Basis for Processing (EEA/UK users)</h2>
+          <p>
+            For users in the European Economic Area or the United Kingdom, processing
+            of technical log data is based on our legitimate interests in ensuring the
+            security, stability, and proper functioning of the Service.
+          </p>
+
+          <h2>5. Data Retention</h2>
+          <p>
+            Server logs are retained only for the minimum period required by applicable
+            laws and institutional policies, after which they are deleted or anonymized.
+          </p>
+
+          <h2>6. Data Sharing</h2>
+          <p>
+            We do not sell, rent, or share personal data with third parties.
+          </p>
+          <p>
+            Data may be disclosed only if required by law or as reasonably necessary to
+            protect the security and integrity of the Service.
+          </p>
+
+          <h2>7. International Users</h2>
+          <p>
+            The Service is operated from the United States. By using the Service, you
+            acknowledge that technical information described in this Privacy Policy may
+            be processed in the United States.
+          </p>
+
+          <h2>8. Your Rights</h2>
+          <p>
+            Depending on your jurisdiction, you may have rights regarding your personal
+            data, including rights to access, correct, delete, or object to certain
+            processing.
+          </p>
+          <p>
+            Because we do not maintain user accounts or directly identifiable user
+            profiles, we may not be able to link technical log data to a specific
+            individual except where required by law and reasonably feasible.
+          </p>
+
+          <h2>9. Children’s Privacy</h2>
+          <p>
+            The Service is intended for academic and general audiences and does not
+            knowingly collect personal data from children.
+          </p>
+
+          <h2>10. Security</h2>
+          <p>
+            We implement reasonable technical and organizational measures to protect the
+            Service and associated data, including standard web security practices.
+          </p>
+
+          <h2>11. Changes to This Policy</h2>
+          <p>
+            This Privacy Policy may be updated from time to time. Updates will be
+            posted on this page with a revised “Last updated” date.
+          </p>
+
+          <h2>12. Contact</h2>
+          <p>
+            For questions about this Privacy Policy, please contact:
+          </p>
+          <p>
+            <a href="mailto:info@cfht.hawaii.edu">info@cfht.hawaii.edu</a>
+          </p>
+        </section>
+    </ion-text>
+  </ion-content>
+

pydiet/templates/common/settings.html

@@ -0,0 +1,23 @@
+{#
+# Jinja2 template for PyDIET Settings section.
+#
+# Copyright CFHT/CNRS/OSUPS/CEA/UParisSaclay
+# Licensed under the MIT licence
+#}
+<ion-list>
+  <ion-list-header>Settings</ion-list-header>
+  <ion-item slot="start">
+    <ion-label position="fixed">Theme</ion-label>
+    <ion-segment id="theme-segment" slot="end" value="auto" scrollable=true mode="ios">
+	{# Theme radio buttons will be inserted here by JS code #}
+    </ion-segment>
+  </ion-item>
+  <ion-item-divider></ion-item-divider>
+  <ion-item slot="start">
+    <ion-label position="fixed">Instrument</ion-label>
+    <ion-segment id="instrument-segment" value="megacam" scrollable=true mode="ios">
+	{# Instrument radio buttons will be inserted here by JS code #}
+    </ion-segment>
+  </ion-item>
+</ion-list>
+

pydiet/templates/common/terms.html

@@ -0,0 +1,101 @@
+  <ion-content class="ion-padding">
+    <ion-text color="medium">
+      <section class="terms-of-service">
+        <h1>Terms of Service</h1>
+        <p><em>Last updated: March 17, 2026</em></p>
+
+        <p>
+          These Terms of Service (“Terms”) govern your use of
+          <strong>PyDIET</strong> (the “Service”), operated by
+          <a href="https://www.cfht.hawaii.edu"><strong>CFHT</strong></a>, a
+            U.S.-based non-profit research organization.
+          By accessing or using the Service, you agree to these Terms.
+        </p>
+
+        <h2>1. Description of the Service</h2>
+        <p>
+          The Service provides an exposure time calculator (ETC) intended for
+          academic, research, and educational purposes. The Service is provided
+          without user authentication and may be accessed via a web interface or API.
+        </p>
+
+        <h2>2. Open Source Software</h2>
+        <p>
+          The underlying code of the Service is made available under the MIT License.
+          Your use of the source code is governed by the terms of that license.
+        </p>
+
+        <h2>3. No Warranty</h2>
+        <p>
+          The Service is provided “as is” and “as available,” without warranty of any
+          kind, express or implied, including but not limited to warranties of
+          accuracy, reliability, fitness for a particular purpose, or non-infringement.
+        </p>
+        <p>
+          The results produced by the Service are estimates only and may not reflect
+          actual observational or instrumental performance.
+        </p>
+
+        <h2>4. Limitation of Liability</h2>
+        <p>
+          To the fullest extent permitted by applicable law, CFHT shall
+          not be liable for any direct, indirect, incidental, consequential, or
+          special damages arising out of or in connection with the use of, or inability
+          to use, the Service, including but not limited to errors in calculations,
+          scientific results, or observational planning.
+        </p>
+
+        <h2>5. Use of the Service</h2>
+        <p>
+          You agree to use the Service only for lawful purposes and in a manner
+          consistent with its intended academic and research use. You are solely
+          responsible for how you interpret and use the results.
+        </p>
+
+        <h2>6. Modifications to the Service</h2>
+        <p>
+          CFHT reserves the right to modify, update, or discontinue any
+          aspect of the Service at any time without notice.
+        </p>
+        <p>
+          This includes, but is not limited to, changes in instrument models,
+          calibration data, algorithms, or implementation details, which may result
+          in differences in the outputs produced by the Service over time.
+        </p>
+
+        <h2>7. Availability</h2>
+        <p>
+          The Service may be unavailable from time to time due to maintenance,
+          updates, or technical issues. No guarantee of uptime or availability is
+          provided.
+        </p>
+
+        <h2>8. Third-Party Use and API</h2>
+        <p>
+          The Service may be accessed programmatically via an API. Excessive or abusive
+          use may be restricted to ensure fair access and system stability.
+        </p>
+
+        <h2>9. Governing Law</h2>
+        <p>
+          These Terms shall be governed by and construed in accordance with the laws
+          of the United States, without regard to conflict of law principles.
+        </p>
+
+        <h2>10. Changes to These Terms</h2>
+        <p>
+          These Terms may be updated from time to time. Continued use of the Service
+          after changes are posted constitutes acceptance of the revised Terms.
+        </p>
+
+        <h2>11. Contact</h2>
+        <p>
+          For questions regarding these Terms, please contact:
+        </p>
+        <p>
+          <a href="mailto:info@cfht.hawaii.edu">info@cfht.hawaii.edu</a>
+        </p>
+      </section>
+    </ion-text>
+  </ion-content>
+