donna 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

donna/{world → workspaces}/markdown.py

@@ -1,7 +1,6 @@
 import enum
 from typing import Any
 
-import pydantic
 from markdown_it import MarkdownIt
 from markdown_it.token import Token
 from markdown_it.tree import SyntaxTreeNode
@@ -11,7 +10,7 @@ from donna.core.entities import BaseEntity
 from donna.core.errors import ErrorsList
 from donna.core.result import Err, Ok, Result, unwrap_to_error
 from donna.domain.ids import FullArtifactId
-from donna.world import errors as world_errors
+from donna.workspaces import errors as world_errors
 
 
 class SectionLevel(str, enum.Enum):
@@ -54,8 +53,6 @@ class SectionSource(BaseEntity):
     original_tokens: list[Token]
     analysis_tokens: list[Token]
 
-    model_config = pydantic.ConfigDict(frozen=False)
-
     def _as_markdown(self, tokens: list[Token], with_title: bool) -> str:
         parts = []
 
@@ -110,15 +107,21 @@ def clear_heading(text: str) -> str:
 def _parse_h1(
     sections: list[SectionSource], node: SyntaxTreeNode, artifact_id: FullArtifactId | None
 ) -> Result[SyntaxTreeNode | None, ErrorsList]:
-    section = sections[-1]
-
-    if section.level != SectionLevel.h1:
+    if sections and any(section.level == SectionLevel.h1 for section in sections):
         return Err([world_errors.MarkdownMultipleH1Sections(artifact_id=artifact_id)])
 
-    if section.title is not None:
-        return Err([world_errors.MarkdownMultipleH1Titles(artifact_id=artifact_id)])
+    if sections:
+        return Err([world_errors.MarkdownH1SectionMustBeFirst(artifact_id=artifact_id)])
+
+    new_section = SectionSource(
+        level=SectionLevel.h1,
+        title=clear_heading(render_back(node.to_tokens()).strip()),
+        original_tokens=[],
+        analysis_tokens=[],
+        configs=[],
+    )
 
-    section.title = clear_heading(render_back(node.to_tokens()).strip())
+    sections.append(new_section)
 
     return Ok(node.next_sibling)
 
@@ -126,10 +129,9 @@ def _parse_h1(
 def _parse_h2(
     sections: list[SectionSource], node: SyntaxTreeNode, artifact_id: FullArtifactId | None
 ) -> Result[SyntaxTreeNode | None, ErrorsList]:
-    section = sections[-1]
 
-    if section.title is None:
-        return Err([world_errors.MarkdownH2BeforeH1Title(artifact_id=artifact_id)])
+    if not sections:
+        return Err([world_errors.MarkdownH1SectionMustBeFirst(artifact_id=artifact_id)])
 
     new_section = SectionSource(
         level=SectionLevel.h2,
@@ -147,7 +149,6 @@ def _parse_h2(
 def _parse_heading(
     sections: list[SectionSource], node: SyntaxTreeNode, artifact_id: FullArtifactId | None
 ) -> Result[SyntaxTreeNode | None, ErrorsList]:
-    section = sections[-1]
 
     if node.tag == "h1":
         return _parse_h1(sections, node, artifact_id)
@@ -155,7 +156,11 @@ def _parse_heading(
     if node.tag == "h2":
         return _parse_h2(sections, node, artifact_id)
 
-    section.original_tokens.extend(node.to_tokens())
+    if not sections:
+        return Err([world_errors.MarkdownH1SectionMustBeFirst(artifact_id=artifact_id)])
+
+    sections[-1].original_tokens.extend(node.to_tokens())
+
     return Ok(node.next_sibling)
 
 
@@ -231,15 +236,7 @@ def parse(  # noqa: CCR001, CFQ001
     # we do not need root node
     node: SyntaxTreeNode | None = SyntaxTreeNode(tokens).children[0]
 
-    sections: list[SectionSource] = [
-        SectionSource(
-            level=SectionLevel.h1,
-            title=None,
-            original_tokens=[],
-            analysis_tokens=[],
-            configs=[],
-        )
-    ]
+    sections: list[SectionSource] = []
 
     while node is not None:
 
@@ -263,5 +260,3 @@ def parse(  # noqa: CCR001, CFQ001
         node = node.next_sibling
 
     return Ok(sections)
-
-    return sections

donna/{world → workspaces}/sources/base.py

@@ -13,8 +13,8 @@ from donna.machine.primitives import Primitive
 if TYPE_CHECKING:
     from donna.domain.ids import FullArtifactId
     from donna.machine.artifacts import Artifact
-    from donna.world.artifacts import ArtifactRenderContext
-    from donna.world.config import SourceConfig as SourceConfigModel
+    from donna.workspaces.artifacts import ArtifactRenderContext
+    from donna.workspaces.config import SourceConfig as SourceConfigModel
 
 
 class SourceConfig(BaseEntity, ABC):

donna/{world → workspaces}/sources/markdown.py

@@ -6,11 +6,11 @@ from donna.core.result import Err, Ok, Result, unwrap_to_error
 from donna.domain.ids import ArtifactSectionId, FullArtifactId, PythonImportPath
 from donna.machine.artifacts import Artifact, ArtifactSection, ArtifactSectionConfig, ArtifactSectionMeta
 from donna.machine.primitives import Primitive, resolve_primitive
-from donna.world import errors as world_errors
-from donna.world import markdown
-from donna.world.artifacts import ArtifactRenderContext
-from donna.world.sources.base import SourceConfig, SourceConstructor
-from donna.world.templates import RenderMode, render
+from donna.workspaces import errors as world_errors
+from donna.workspaces import markdown
+from donna.workspaces.artifacts import ArtifactRenderContext
+from donna.workspaces.sources.base import SourceConfig, SourceConstructor
+from donna.workspaces.templates import RenderMode, render
 
 
 class MarkdownSectionConstructor(Protocol):
@@ -111,6 +111,7 @@ class MarkdownSectionMixin:
                 kind=section_config.kind,
                 title=title,
                 description=description,
+                tags=section_config.tags,
                 primary=primary,
                 meta=meta,
             )
@@ -140,7 +141,7 @@ def parse_artifact_content(
         )
 
     if not original_sections:
-        # return Envrironment errors
+        # return Environment errors
         return Err([world_errors.MarkdownArtifactWithoutSections(artifact_id=full_id)])
 
     for original, analyzed in zip(original_sections, analyzed_sections):
@@ -257,4 +258,4 @@ def _ensure_markdown_constructible(
 
 
 if TYPE_CHECKING:
-    from donna.world.config import SourceConfig as SourceConfigModel
+    from donna.workspaces.config import SourceConfig as SourceConfigModel

donna/{world → workspaces}/templates.py

@@ -12,10 +12,10 @@ from donna.core.errors import EnvironmentErrorsProxy, ErrorsList
 from donna.core.result import Err, Ok, Result
 from donna.domain.ids import FullArtifactId
 from donna.machine.templates import Directive
-from donna.world import errors as world_errors
+from donna.workspaces import errors as world_errors
 
 if TYPE_CHECKING:
-    from donna.world.artifacts import ArtifactRenderContext
+    from donna.workspaces.artifacts import ArtifactRenderContext
 
 
 class RenderMode(enum.Enum):
@@ -57,7 +57,7 @@ class DirectivePathBuilder:
         return DirectivePathBuilder(self._parts + (name,))
 
     @jinja2.pass_context
-    def __call__(self, context: jinja2.runtime.Context, *argv: object) -> object:  # noqa: CCR001
+    def __call__(self, context: jinja2.runtime.Context, *argv: object, **kwargs: object) -> object:  # noqa: CCR001
         artifact_id = context.get("artifact_id")
         directive_path = ".".join(self._parts)
         if len(self._parts) < 2:
@@ -112,7 +112,7 @@ class DirectivePathBuilder:
             )
 
         try:
-            result = directive.apply_directive(context, *argv)
+            result = directive.apply_directive(context, *argv, **kwargs)
         except EnvironmentErrorsProxy:
             raise
         except core_errors.InternalError:

donna/workspaces/tmp.py

@@ -0,0 +1,51 @@
+import pathlib
+import shutil
+import time
+
+from donna.cli.types import FullArtifactIdArgument
+from donna.workspaces.config import config, config_dir
+
+
+def dir() -> pathlib.Path:
+    cfg = config()
+    tmp_path = cfg.tmp_dir
+
+    if not cfg.tmp_dir.is_absolute():
+        tmp_path = config_dir() / tmp_path
+
+    tmp_path.mkdir(parents=True, exist_ok=True)
+
+    return tmp_path
+
+
+def file_for_artifact(artifact_id: FullArtifactIdArgument, extension: str) -> pathlib.Path:
+    directory = dir()
+
+    directory.mkdir(parents=True, exist_ok=True)
+
+    normalized_extension = extension.lstrip(".")
+    artifact_file_name = f"{str(artifact_id).replace('/', '.')}.{int(time.time() * 1000)}.{normalized_extension}"
+
+    return directory / artifact_file_name
+
+
+def file_for_slug(slug: str, extension: str) -> pathlib.Path:
+    directory = dir()
+
+    directory.mkdir(parents=True, exist_ok=True)
+
+    normalized_slug = slug.replace("/", ".").replace("\\", ".")
+    normalized_extension = extension.lstrip(".")
+    artifact_file_name = f"{normalized_slug}.{int(time.time() * 1000)}.{normalized_extension}"
+
+    return directory / artifact_file_name
+
+
+def create_file_for_slug(slug: str, extension: str) -> pathlib.Path:
+    path = file_for_slug(slug, extension)
+    path.touch()
+    return path
+
+
+def clear() -> None:
+    shutil.rmtree(dir())

donna/{world → workspaces}/worlds/base.py

@@ -11,8 +11,8 @@ from donna.machine.artifacts import Artifact
 from donna.machine.primitives import Primitive
 
 if TYPE_CHECKING:
-    from donna.world.artifacts import ArtifactRenderContext
-    from donna.world.config import WorldConfig
+    from donna.workspaces.artifacts import ArtifactRenderContext
+    from donna.workspaces.config import WorldConfig
 
 
 class World(BaseEntity, ABC):
@@ -36,6 +36,9 @@ class World(BaseEntity, ABC):
         self, artifact_id: ArtifactId, content: bytes, extension: str
     ) -> Result[None, ErrorsList]: ...  # noqa: E704
 
+    @abstractmethod
+    def remove(self, artifact_id: ArtifactId) -> Result[None, ErrorsList]: ...  # noqa: E704
+
     @abstractmethod
     def file_extension_for(self, artifact_id: ArtifactId) -> Result[str, ErrorsList]: ...  # noqa: E704
 
@@ -47,7 +50,7 @@ class World(BaseEntity, ABC):
     # For the artifact: uniform API for storing/loading data
     # Against the artifact:
     # - session data MUST be accessible only by Donna => no one should be able to read/write/list it
-    # - session data will require an additonal kind(s) of artifact(s) just for that purpose
+    # - session data will require an additional kind(s) of artifact(s) just for that purpose
     # - session data may change more frequently than regular artifacts
 
     @abstractmethod

donna/{world → workspaces}/worlds/filesystem.py

@@ -6,14 +6,14 @@ from donna.core.errors import ErrorsList
 from donna.core.result import Err, Ok, Result, unwrap_to_error
 from donna.domain.ids import ArtifactId, FullArtifactId, FullArtifactIdPattern
 from donna.machine.artifacts import Artifact
-from donna.world import errors as world_errors
-from donna.world.artifacts import ArtifactRenderContext
-from donna.world.artifacts_discovery import ArtifactListingNode, list_artifacts_by_pattern
-from donna.world.worlds.base import World as BaseWorld
-from donna.world.worlds.base import WorldConstructor
+from donna.workspaces import errors as world_errors
+from donna.workspaces.artifacts import ArtifactRenderContext
+from donna.workspaces.artifacts_discovery import ArtifactListingNode, list_artifacts_by_pattern
+from donna.workspaces.worlds.base import World as BaseWorld
+from donna.workspaces.worlds.base import WorldConstructor
 
 if TYPE_CHECKING:
-    from donna.world.config import SourceConfigValue, WorldConfig
+    from donna.workspaces.config import SourceConfigValue, WorldConfig
 
 
 class World(BaseWorld):
@@ -35,7 +35,7 @@ class World(BaseWorld):
         if not parent.exists():
             return Ok(None)
 
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         supported_extensions = config().supported_extensions()
         matches = [
@@ -55,7 +55,7 @@ class World(BaseWorld):
     def _get_source_by_filename(
         self, artifact_id: ArtifactId, filename: str
     ) -> Result["SourceConfigValue", ErrorsList]:
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         extension = pathlib.Path(filename).suffix
         source_config = config().find_source_for_extension(extension)
@@ -89,7 +89,7 @@ class World(BaseWorld):
         full_id = FullArtifactId((self.id, artifact_id))
 
         extension = pathlib.Path(path.name).suffix
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         source_config = config().find_source_for_extension(extension)
         if source_config is None:
@@ -123,6 +123,20 @@ class World(BaseWorld):
         path.write_bytes(content)
         return Ok(None)
 
+    @unwrap_to_error
+    def remove(self, artifact_id: ArtifactId) -> Result[None, ErrorsList]:
+        if self.readonly:
+            return Err([world_errors.WorldReadonly(world_id=self.id)])
+
+        path = self._resolve_artifact_file(artifact_id).unwrap()
+
+        if path is None:
+            return Ok(None)
+
+        path.unlink()
+
+        return Ok(None)
+
     @unwrap_to_error
     def file_extension_for(self, artifact_id: ArtifactId) -> Result[str, ErrorsList]:
         path = self._resolve_artifact_file(artifact_id).unwrap()
@@ -181,9 +195,15 @@ class FilesystemWorldConstructor(WorldConstructor):
         if path_value is None:
             raise ValueError(f"World config '{config.id}' does not define a filesystem path")
 
+        from donna.workspaces.config import project_dir
+
+        path = pathlib.Path(path_value).expanduser()
+        if not path.is_absolute():
+            path = project_dir() / path
+
         return World(
             id=config.id,
-            path=pathlib.Path(path_value),
+            path=path.resolve(),
             readonly=config.readonly,
             session=config.session,
         )

donna/{world → workspaces}/worlds/python.py

@@ -7,14 +7,14 @@ from donna.core.errors import ErrorsList
 from donna.core.result import Err, Ok, Result, unwrap_to_error
 from donna.domain.ids import ArtifactId, FullArtifactId, FullArtifactIdPattern, WorldId
 from donna.machine.artifacts import Artifact
-from donna.world import errors as world_errors
-from donna.world.artifacts import ArtifactRenderContext
-from donna.world.artifacts_discovery import ArtifactListingNode, list_artifacts_by_pattern
-from donna.world.worlds.base import World as BaseWorld
-from donna.world.worlds.base import WorldConstructor
+from donna.workspaces import errors as world_errors
+from donna.workspaces.artifacts import ArtifactRenderContext
+from donna.workspaces.artifacts_discovery import ArtifactListingNode, list_artifacts_by_pattern
+from donna.workspaces.worlds.base import World as BaseWorld
+from donna.workspaces.worlds.base import WorldConstructor
 
 if TYPE_CHECKING:
-    from donna.world.config import SourceConfigValue, WorldConfig
+    from donna.workspaces.config import SourceConfigValue, WorldConfig
 
 
 class Python(BaseWorld):
@@ -59,7 +59,7 @@ class Python(BaseWorld):
         if not resource_dir.is_dir():
             return Ok(None)
 
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         supported_extensions = config().supported_extensions()
         matches = [
@@ -81,7 +81,7 @@ class Python(BaseWorld):
     def _get_source_by_filename(
         self, artifact_id: ArtifactId, filename: str
     ) -> Result["SourceConfigValue", ErrorsList]:
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         extension = pathlib.Path(filename).suffix
         source_config = config().find_source_for_extension(extension)
@@ -115,7 +115,7 @@ class Python(BaseWorld):
         full_id = FullArtifactId((self.id, artifact_id))
 
         extension = pathlib.Path(resource_path.name).suffix
-        from donna.world.config import config
+        from donna.workspaces.config import config
 
         source_config = config().find_source_for_extension(extension)
         if source_config is None:
@@ -142,6 +142,9 @@ class Python(BaseWorld):
     def update(self, artifact_id: ArtifactId, content: bytes, extension: str) -> Result[None, ErrorsList]:
         return Err([world_errors.WorldReadonly(world_id=self.id)])
 
+    def remove(self, artifact_id: ArtifactId) -> Result[None, ErrorsList]:
+        return Err([world_errors.WorldReadonly(world_id=self.id)])
+
     @unwrap_to_error
     def file_extension_for(self, artifact_id: ArtifactId) -> Result[str, ErrorsList]:
         resource_path = self._resolve_artifact_file(artifact_id).unwrap()