Skip to content

sharing

NoseyPath

Wrapper for Path objects that allows tracking of what paths have been generated from that object.

This 'nosey' behaviour is used to keep track of which files are accessed through Path objects.

Parameters:

Name Type Description Default
path Path

path to wrap around.

 required
Source code in cassini/sharing.py 
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
class NoseyPath:
    """
    Wrapper for `Path` objects that allows tracking of what paths have been generated from that object.

    This 'nosey' behaviour is used to keep track of which files are accessed through `Path` objects.

    Parameters
    ----------
    path: Path
        path to wrap around.
    """

    @classmethod
    def from_parent(cls, path: Path, parent: Self):
        """
        Create a new `NoseyPath` as a 'child' of `parent`.

        Allows parent to keep track of its child paths.
        """
        obj = cls(path)
        obj._children = parent._children
        parent._children.append(obj)

        return obj

    def __init__(self, path: Path) -> None:
        self._path: Path = path
        self._children: List[Self] = []

    def __getattr__(self, name: str) -> Any:
        val = getattr(self._path, name)

        if isinstance(val, MethodType):

            def wrapper(*args, **kwargs):
                result = val(*args, **kwargs)

                if isinstance(result, Path):
                    result = NoseyPath.from_parent(result, self)

                return result

            return wrapper

        if isinstance(val, Path):
            val = NoseyPath.from_parent(val, self)

        return val

    def __truediv__(self, other: Union[str, Path]) -> Path:
        return self.__getattr__("__truediv__")(other)

    def __eq__(self, other):
        if isinstance(other, NoseyPath):
            other = other._path
        return self._path.__eq__(other)

    def __repr__(self):
        return f"<NoseyPath ({self._path})>"

    def _unchain(self) -> Dict[str, Any]:
        """
        Creates a tree structure that contains all segments of the children of this object.
        """
        segments: Dict[str, Any] = {}

        for child in self._children:
            path = segments
            if child.is_absolute():
                child = child.relative_to(self._path)

            for part in child.parts:
                next_path = path.get(part)

                if next_path is None:
                    next_path = path[part] = {}

                path = next_path

        return segments

    def _recurse_segments(
        self, level: Dict[str, Any], path: List[str], sub_paths: List[List[str]]
    ):
        """
        Recurse through the `level`, keeping track of the `path` and add complete paths to sub_paths.
        """
        for name, branch in level.items():
            path.append(name)

            if not branch:
                sub_paths.append(path.copy())
                path.clear()
            else:
                self._recurse_segments(branch, path, sub_paths)

    def compress(self) -> List[Path]:
        """
        Create a list of complete paths that result from this path object e.g. through `__truediv__` calls.
        """
        if not self._children:
            return [self._path]

        tree = self._unchain()
        path: List[str] = []
        sub_paths: List[List[str]] = []

        self._recurse_segments(tree, path, sub_paths)

        paths = [self._path.joinpath(*sub) for sub in sub_paths]

        return paths

from_parent classmethod 

from_parent(path, parent)

Create a new NoseyPath as a 'child' of parent.

Allows parent to keep track of its child paths.

Source code in cassini/sharing.py 
40
41
42
43
44
45
46
47
48
49
50
51
@classmethod
def from_parent(cls, path: Path, parent: Self):
    """
    Create a new `NoseyPath` as a 'child' of `parent`.

    Allows parent to keep track of its child paths.
    """
    obj = cls(path)
    obj._children = parent._children
    parent._children.append(obj)

    return obj

compress 

compress()

Create a list of complete paths that result from this path object e.g. through __truediv__ calls.

Source code in cassini/sharing.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def compress(self) -> List[Path]:
    """
    Create a list of complete paths that result from this path object e.g. through `__truediv__` calls.
    """
    if not self._children:
        return [self._path]

    tree = self._unchain()
    path: List[str] = []
    sub_paths: List[List[str]] = []

    self._recurse_segments(tree, path, sub_paths)

    paths = [self._path.joinpath(*sub) for sub in sub_paths]

    return paths

SharingTier

Wrapper around a TierABC object that keeps track of what attributes are accessed and what methods are called.

This class can then create a serialised version of tier using SharedTierData, which can allow a SharedTier object to be created that emulates this SharingTier.

This class should not be created directly. Instead, SharableProject objects should be used.

Parameters:

Name Type Description Default
name str

The name of the tier to wrap around.

 required
Notes

This class is not in a valid state until SharingTier.load has been called.

Source code in cassini/sharing.py 
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
class SharingTier:
    """
    Wrapper around a `TierABC` object that keeps track of what attributes are accessed
    and what methods are called.

    This class can then create a serialised version of `tier` using `SharedTierData`, which can
    allow a `SharedTier` object to be created that emulates this `SharingTier`.

    This class should not be created directly. Instead, `SharableProject` objects should be used.

    Parameters
    ----------
    name: str
        The name of the tier to wrap around.

    Notes
    -----
    This class is not in a valid state until `SharingTier.load` has been called.
    """

    def __init__(self, name: str):
        self.sharing_project: Union[None, ShareableProject] = None

        self._accessed: Dict[str, Any] = {}
        self._called: Dict[str, Dict[ArgsKwargsType, Any]] = defaultdict(dict)
        self.name = name
        self._paths_used: List[NoseyPath] = []

        self._tier: Union[TierABC, None] = None
        self.meta: Union[Meta, None] = None

    @classmethod
    def with_project(cls, name: str, sharing_project: ShareableProject):
        """
        Create a `SharingTier` object, and load it from `shared_project`.

        Recommended way to create `SharingTier` objects in contexts where the `shared_project` is available.
        """
        tier = cls(name)
        tier.load(sharing_project=sharing_project)

        sharing_project.shared_tiers.append(tier)

        return tier

    def load(self, sharing_project: ShareableProject):
        """
        Sync this `SharingTier` to wrap around the tier with name `self.name` from the `shared_project`.
        """
        self.sharing_project = sharing_project

        self._tier = sharing_project.project[self.name]

        self.meta = getattr(self._tier, "meta", None)

    meta_model = NotebookTierBase.meta_model

    description = NotebookTierBase.description
    conclusion = NotebookTierBase.conclusion
    started = NotebookTierBase.started

    def handle_attr(self, name: str, val: Any) -> Any:
        """
        Handle attribute access to cache the result appropriately.
        """
        if isinstance(val, (str, int, list, datetime.date, Path)):
            self._accessed[name] = val

        if isinstance(val, Path):
            val = NoseyPath(val)
            self._paths_used.append(val)

        if isinstance(val, TierABC):
            assert self.sharing_project
            val = self._accessed[name] = SharingTier.with_project(
                val.name, self.sharing_project
            )

        return val

    def handle_call(self, method: str, args_kwargs: ArgsKwargsType, val: Any) -> Any:
        """
        Handle call to a method to allow caching of the result.
        """
        if isinstance(val, TierABC):
            assert self.sharing_project
            val = SharingTier.with_project(val.name, self.sharing_project)

        self._called[method][args_kwargs] = val

        if isinstance(val, Path):
            val = NoseyPath(val)
            self._paths_used.append(val)

        return val

    def __getattr__(self, name: str) -> Any:
        if self.sharing_project is None:
            raise RuntimeError(
                "SharingTier attributes can be accessed until `SharingTier.load` is called"
            )

        val = getattr(self._tier, name)

        if isinstance(val, MethodType):
            handle_call = self.handle_call
            meth = val

            def wrapper(*args, **kwargs) -> Any:
                args_kwargs = (args, tuple(kwargs.items()))

                result = meth(*args, **kwargs)

                return handle_call(name, args_kwargs, result)

            val = wrapper
        else:
            val = self.handle_attr(name, val)

        return val

    def __getitem__(self, other) -> Self:
        return self.__getattr__("__getitem__")(other)

    def __truediv__(self, other) -> Path:
        return self.__getattr__("__truediv__")(other)

    def __eq__(self, other):
        if isinstance(other, (SharedTier, SharingTier)):
            return self.name == other.name
        else:
            raise NotImplementedError()

    def __hash__(self):
        return hash(self.name)

    def dump(self, fs: TextIOWrapper) -> SharedTierData:
        """
        Serialise the cached version of the attribute and function calls to wrapped tier.

        Parameters
        ----------
        fs: TextIOWrapper
            Stream to write serialised data to.

        Returns
        -------
        model: SharedTierData
            Model of this instance.
        """

        called = defaultdict(list)

        for meth, calls in self._called.items():
            for args_kwargs, returns in calls.items():
                called[meth.strip("_")].append(
                    {
                        "args": args_kwargs[0],
                        "kwargs": args_kwargs[1],
                        "returns": returns,
                    }
                )

        called_obj = SharedTierCalls(**called)  # type: ignore[arg-type]

        model = SharedTierData(
            **self._accessed, base_path=self.project.project_folder, called=called_obj
        )

        json_str = model.model_dump_json()
        fs.write(json_str)

        return model

    def find_paths(self) -> List[Path]:
        """
        Go through self._accessed, self._called and find the paths and get their full extent.
        """
        paths: List[Path] = []

        for nosey_path in self._paths_used:
            paths.extend(nosey_path.compress())

        return paths

with_project classmethod 

with_project(name, sharing_project)

Create a SharingTier object, and load it from shared_project.

Recommended way to create SharingTier objects in contexts where the shared_project is available.

Source code in cassini/sharing.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
@classmethod
def with_project(cls, name: str, sharing_project: ShareableProject):
    """
    Create a `SharingTier` object, and load it from `shared_project`.

    Recommended way to create `SharingTier` objects in contexts where the `shared_project` is available.
    """
    tier = cls(name)
    tier.load(sharing_project=sharing_project)

    sharing_project.shared_tiers.append(tier)

    return tier

load 

load(sharing_project)

Sync this SharingTier to wrap around the tier with name self.name from the shared_project.

Source code in cassini/sharing.py 
190
191
192
193
194
195
196
197
198
def load(self, sharing_project: ShareableProject):
    """
    Sync this `SharingTier` to wrap around the tier with name `self.name` from the `shared_project`.
    """
    self.sharing_project = sharing_project

    self._tier = sharing_project.project[self.name]

    self.meta = getattr(self._tier, "meta", None)

handle_attr 

handle_attr(name, val)

Handle attribute access to cache the result appropriately.

Source code in cassini/sharing.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def handle_attr(self, name: str, val: Any) -> Any:
    """
    Handle attribute access to cache the result appropriately.
    """
    if isinstance(val, (str, int, list, datetime.date, Path)):
        self._accessed[name] = val

    if isinstance(val, Path):
        val = NoseyPath(val)
        self._paths_used.append(val)

    if isinstance(val, TierABC):
        assert self.sharing_project
        val = self._accessed[name] = SharingTier.with_project(
            val.name, self.sharing_project
        )

    return val

handle_call 

handle_call(method, args_kwargs, val)

Handle call to a method to allow caching of the result.

Source code in cassini/sharing.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
def handle_call(self, method: str, args_kwargs: ArgsKwargsType, val: Any) -> Any:
    """
    Handle call to a method to allow caching of the result.
    """
    if isinstance(val, TierABC):
        assert self.sharing_project
        val = SharingTier.with_project(val.name, self.sharing_project)

    self._called[method][args_kwargs] = val

    if isinstance(val, Path):
        val = NoseyPath(val)
        self._paths_used.append(val)

    return val

dump 

dump(fs)

Serialise the cached version of the attribute and function calls to wrapped tier.

Parameters:

Name Type Description Default
fs TextIOWrapper

Stream to write serialised data to.

 required

Returns:

Name Type Description
model SharedTierData

Model of this instance.
Source code in cassini/sharing.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
def dump(self, fs: TextIOWrapper) -> SharedTierData:
    """
    Serialise the cached version of the attribute and function calls to wrapped tier.

    Parameters
    ----------
    fs: TextIOWrapper
        Stream to write serialised data to.

    Returns
    -------
    model: SharedTierData
        Model of this instance.
    """

    called = defaultdict(list)

    for meth, calls in self._called.items():
        for args_kwargs, returns in calls.items():
            called[meth.strip("_")].append(
                {
                    "args": args_kwargs[0],
                    "kwargs": args_kwargs[1],
                    "returns": returns,
                }
            )

    called_obj = SharedTierCalls(**called)  # type: ignore[arg-type]

    model = SharedTierData(
        **self._accessed, base_path=self.project.project_folder, called=called_obj
    )

    json_str = model.model_dump_json()
    fs.write(json_str)

    return model

find_paths 

find_paths()

Go through self._accessed, self._called and find the paths and get their full extent.

Source code in cassini/sharing.py 
319
320
321
322
323
324
325
326
327
328
def find_paths(self) -> List[Path]:
    """
    Go through self._accessed, self._called and find the paths and get their full extent.
    """
    paths: List[Path] = []

    for nosey_path in self._paths_used:
        paths.extend(nosey_path.compress())

    return paths

SharedTierGui

Essentially a mock version of TierGui, for use during a shared context.

Source code in cassini/sharing.py 
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
class SharedTierGui:
    """
    Essentially a mock version of TierGui, for use during a shared context.
    """

    def __init__(self, stier: SharedTier):
        self.stier = stier

    def header(self):
        print(
            "Cassini header cannot gui cannot be used in a shared context - check out cassini to set it up for yourself!"
        )

    def meta_editor(self, name=None):
        print(
            "Cassini meta editor cannot be used in a shared context - check out cassini to set it up for yourself!"
        )

SharedTier

A class that emulates a TierABC object without needing a full cassini Project configured.

This class is the mirror of SharingTier objects, which create the serialised files required to load these objects.

Parameters:

Name Type Description Default
name str

The name of the tier to emulate.

 required
Notes

This class is not in a valid state until SharedTier.load has been called.

Source code in cassini/sharing.py 
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
class SharedTier:
    """
    A class that emulates a `TierABC` object without needing a full cassini `Project` configured.

    This class is the mirror of `SharingTier` objects, which create the serialised files required
    to load these objects.

    Parameters
    ----------
    name: str
        The name of the tier to emulate.

    Notes
    -----
    This class is not in a valid state until `SharedTier.load` has been called.
    """

    def __init__(self, name: str) -> None:
        self.name = name
        self.shared_project: Union[None, ShareableProject] = None
        self.base_path: Union[Path, None] = None
        self.meta: Union[Meta, None] = None
        self.gui = SharedTierGui(self)

        self._accessed: Dict[str, Any] = {}
        self._called: Dict[str, Dict[ArgsKwargsType, Any]] = {}

    @classmethod
    def with_project(cls, name: str, shared_project: ShareableProject):
        """
        Create a `SharedTier` instance, and load it from `shared_project`.
        """
        tier = cls(name)
        tier.load(shared_project)
        return tier

    def load(self, shared_project: ShareableProject):
        """
        Load the contents of the shared tier into this object from the `shared_project`.
        """
        self.shared_project = shared_project

        folder, meta_file, frozen_file = shared_project.make_paths(self)

        if meta_file.exists():
            self.meta = Meta.create_meta(meta_file, self)

        with open(frozen_file) as fs:
            model = SharedTierData.model_validate_json(fs.read())
            self.base_path = model.base_path

            accessed = model.model_dump(exclude={"called", "base_path"})
            self._accessed = accessed

            raw_called = model.called.model_dump()

            called: Dict[str, Any] = defaultdict(dict)

            for method, calls in raw_called.items():
                if method in ["truediv", "getitem"]:
                    method = f"__{method}__"

                for call in calls:
                    called[method][(call["args"], call["kwargs"])] = call["returns"]

            self._called = called

    meta_model = NotebookTierBase.meta_model

    description = NotebookTierBase.description
    conclusion = NotebookTierBase.conclusion
    started = NotebookTierBase.started

    def adjust_path(self, path: Path) -> Path:
        """
        Correct path to account for new base path.
        """
        assert self.shared_project
        assert self.base_path

        return self.shared_project.requires_path / path.relative_to(self.base_path)

    def process_tier_val(self, val: Any) -> Any:
        if isinstance(val, Path):
            return self.adjust_path(val)

        if isinstance(val, SharedTier):
            assert self.shared_project
            return SharedTier.with_project(val.name, self.shared_project)

        return val

    def __getattr__(self, name: str) -> Any:
        if self.shared_project is None:
            raise RuntimeError(
                "SharedTier attributes can be accessed until `SharedTier.load` is called"
            )

        if name in self._accessed:
            val = self._accessed[name]

            return self.process_tier_val(val)
        else:

            def meth(*args, **kwargs):
                args_kwargs = (args, tuple(kwargs))

                val = self._called[name][args_kwargs]

                return self.process_tier_val(val)

            return meth

    def __getitem__(self, other: Any) -> Self:
        return self.__getattr__("__getitem__")(other)

    def __truediv__(self, other: Any) -> Path:
        return self.__getattr__("__truediv__")(other)

    def __eq__(self, other):
        if isinstance(other, (SharedTier, SharingTier)):
            return self.name == other.name
        else:
            raise NotImplementedError()

    def __hash__(self) -> int:
        return hash(self.name)

with_project classmethod 

with_project(name, shared_project)

Create a SharedTier instance, and load it from shared_project.

Source code in cassini/sharing.py 
377
378
379
380
381
382
383
384
@classmethod
def with_project(cls, name: str, shared_project: ShareableProject):
    """
    Create a `SharedTier` instance, and load it from `shared_project`.
    """
    tier = cls(name)
    tier.load(shared_project)
    return tier

load 

load(shared_project)

Load the contents of the shared tier into this object from the shared_project.

Source code in cassini/sharing.py 
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
def load(self, shared_project: ShareableProject):
    """
    Load the contents of the shared tier into this object from the `shared_project`.
    """
    self.shared_project = shared_project

    folder, meta_file, frozen_file = shared_project.make_paths(self)

    if meta_file.exists():
        self.meta = Meta.create_meta(meta_file, self)

    with open(frozen_file) as fs:
        model = SharedTierData.model_validate_json(fs.read())
        self.base_path = model.base_path

        accessed = model.model_dump(exclude={"called", "base_path"})
        self._accessed = accessed

        raw_called = model.called.model_dump()

        called: Dict[str, Any] = defaultdict(dict)

        for method, calls in raw_called.items():
            if method in ["truediv", "getitem"]:
                method = f"__{method}__"

            for call in calls:
                called[method][(call["args"], call["kwargs"])] = call["returns"]

        self._called = called

adjust_path 

adjust_path(path)

Correct path to account for new base path.

Source code in cassini/sharing.py 
423
424
425
426
427
428
429
430
def adjust_path(self, path: Path) -> Path:
    """
    Correct path to account for new base path.
    """
    assert self.shared_project
    assert self.base_path

    return self.shared_project.requires_path / path.relative_to(self.base_path)

ShareableTierType

Pydantic style type for allowing serialisation of Shared and Sharing Tiers.

See:

https://docs.pydantic.dev/latest/concepts/types/#handling-third-party-types

Source code in cassini/sharing.py 
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
class ShareableTierType:
    """
    Pydantic style type for allowing serialisation of Shared and Sharing Tiers.

    See:

    https://docs.pydantic.dev/latest/concepts/types/#handling-third-party-types
    """

    @classmethod
    def __get_pydantic_core_schema__(
        cls, source_type: Any, handler: GetCoreSchemaHandler
    ) -> CoreSchema:
        def validate_from_str(name: str) -> SharedTier:
            return SharedTier(name)  # always load as Shared

        from_str_schema = core_schema.chain_schema(
            [
                core_schema.str_schema(),  # first 'validate' as string
                core_schema.no_info_plain_validator_function(validate_from_str),
            ]
        )

        shared_or_sharing_schema = (
            core_schema.union_schema(  # either Shared or Sharing are valid python-side
                [
                    core_schema.is_instance_schema(SharedTier),
                    core_schema.is_instance_schema(SharingTier),
                ]
            )
        )

        return core_schema.json_or_python_schema(
            json_schema=from_str_schema,
            python_schema=shared_or_sharing_schema,
            serialization=core_schema.plain_serializer_function_ser_schema(
                lambda o: o.name,
                when_used="json",  # dumping to Python should maintain type.
            ),
        )

SharedTierData

Bases: BaseModel

Serialised form of a shared tier.

Attributes:

Name Type Description
file Optional[Path]

Absolute path to the file for the notebook.
folder Optional[Path]

Absolute path for folder for the tier.
parent Optional[str]

name of the tier's parent
href Optional[str]

tier's href url
id Optional[str]

the tier's id
identifiers List[str]

the tier's identifiers
meta_file Optional[Path]

Absolute path to the meta file.
base_path Path

Base path used when generating URLs.
called SharedTierCalls

Serialised version of calls made to this tier prior to sharing.
Source code in cassini/sharing.py 
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
class SharedTierData(BaseModel):
    """
    Serialised form of a shared tier.

    Attributes
    ----------
    file: Optional[Path]
        Absolute path to the file for the notebook.
    folder: Optional[Path]
        Absolute path for folder for the tier.
    parent: Optional[str]
        name of the tier's parent
    href: Optional[str]
        tier's href url
    id: Optional[str]
        the tier's id
    identifiers: List[str]
        the tier's identifiers
    meta_file: Optional[Path]
        Absolute path to the meta file.
    base_path: Path
        Base path used when generating URLs.
    called: SharedTierCalls
        Serialised version of calls made to this tier prior to sharing.
    """

    model_config = ConfigDict(extra="allow", validate_assignment=True, strict=True)

    file: Optional[Path] = Field(default=None)
    folder: Optional[Path] = Field(default=None)
    parent: Optional[ShareableTierType] = Field(default=None)
    href: Optional[str] = Field(default=None)
    id: Optional[str] = Field(default=None)
    identifiers: Optional[List[str]] = Field(default=None)
    meta_file: Optional[Path] = Field(default=None)
    base_path: Path

    called: SharedTierCalls

ShareableProject

Shareable version of Project. Allows sharing of notebooks that use Cassini with users who don't have Cassini set up.

This class automatically detects if it's being used in a sharing or shared context and returns the appropriate values. It does this by trying to use cassini.utils.find_project to get ahold of your project instance. If it can't find one, it assumes the code context is shared. If it does find one, it assumes you are still sharing this project.

This object can be used as a substitute for a Project instance.

Parameters:

Name Type Description Default
import_string Union[str, None]

If created in a sharing context, this is used to find the project object, using the syntax specified in cassini.utils.find_project.

 None
location Union[Path, None]

location to store/ load the shared project data. Defaults to Path("Shared").

 None
Source code in cassini/sharing.py 
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
class ShareableProject:
    """
    Shareable version of `Project`. Allows sharing of notebooks that use Cassini with users who don't have
    Cassini set up.

    This class automatically detects if it's being used in a _sharing_ or _shared_ context and returns the appropriate values.
    It does this by trying to use `cassini.utils.find_project` to get ahold of your project instance. If it can't find
    one, it assumes the code context is _shared_. If it does find one, it assumes you are still sharing this project.

    This object can be used as a substitute for a `Project` instance.

    Parameters
    ----------
    import_string: Optional[str]
        If created in a sharing context, this is used to find the `project` object, using the syntax specified
        in `cassini.utils.find_project`.
    location: Optional[Path]
        location to store/ load the shared project data. Defaults to `Path("Shared")`.
    """

    def __new__(cls, *args, **kwargs) -> Self:
        if env.shareable_project:
            warnings.warn(
                "Creating a new instance of SharingProject, when one has already been created. This can create unexpected behaviour."
            )

        obj = super().__new__(cls)
        env.shareable_project = obj
        return obj

    def __init__(
        self, import_string: Union[str, None] = None, location: Union[Path, None] = None
    ) -> None:
        try:
            self.project = find_project(import_string)
        except (RuntimeError, KeyError):
            self.project = None

        self.shared_tiers: List[SharingTier] = []
        self.location = location if location else Path("Shared")

    def env(self, name: str) -> Union[SharedTier, SharingTier]:
        """
        Equivalent to `Project.env`, except will return the appropriate `SharingTier` or `SharedTier`, depending
        on which is appropriate.

        Parameters
        ----------
        name: str
            Name of the tier to get.
        """
        if self.project:
            tier = SharingTier.with_project(name=name, sharing_project=self)
            env.update(tier)
            return tier
        else:
            return SharedTier.with_project(name=name, shared_project=self)

    def __getitem__(self, name: str) -> Union[SharedTier, SharingTier]:
        """
        Equivalent to `Project.env`, except will return the appropriate `SharingTier` or `SharedTier`, depending
        on which is appropriate.

        Parameters
        ----------
        name: str
            Name of the tier to get.
        """
        if self.project:
            return SharingTier.with_project(name=name, sharing_project=self)
        else:
            return SharedTier.with_project(name=name, shared_project=self)

    def make_paths(
        self, tier: Union[SharedTier, SharingTier]
    ) -> Tuple[Path, Path, Path]:
        """
        Build paths required for sharing a given tier object.

        Returns
        -------
        outer: Path
            The folder the tier data is stored in.
        meta_file: Path
            A path to the meta_file of that tier
        frozen_file: Path
            The path to the `frozen.json` file, where the tier's attributes and calls are stored.
        """
        outer = self.location / tier.name

        meta_file = outer / f"{tier.name}.json"
        frozen_file = outer / "frozen.json"

        return outer, meta_file, frozen_file

    @property
    def requires_path(self) -> Path:
        """
        Path for requires folder.
        """
        return self.location / "requires"

    def make_shared(self) -> None:
        """
        Create a shared version of this project.

        Will create a folder a `self.location`. Will then iterate all `tier` objects accessed in this context
        and serialise them.

        Additionally, and files that tiers used access will be copied into the `self.requires_path`.
        """
        if not self.project:
            raise RuntimeError("Trying to share tiers when not in a sharing context.")

        project = self.project

        path = self.location

        print("Creating shared directory:", path)

        path.mkdir(exist_ok=True)

        print("Success")
        print("Making Requires directory")

        self.requires_path.mkdir(exist_ok=True)

        print("Success")

        for stier in self.shared_tiers:
            print(f"Creating shared version of {stier.name}")

            tier_dir, meta_file, frozen_file = self.make_paths(stier)
            tier_dir.mkdir(exist_ok=True)

            if stier.meta:
                print("Copying Meta")
                shutil.copy(stier.meta.file, meta_file)
                print("Success")

            with open(frozen_file, "w") as fs:
                print("Freezing attributes/ calls")
                stier.dump(fs)
                print("Success")

            print("Making a copy of required files")
            for required in stier.find_paths():
                if required.exists():
                    destination = self.requires_path / required.relative_to(
                        project.project_folder
                    )
                    directory = destination if required.is_dir() else destination.parent
                    directory.mkdir(exist_ok=True, parents=True)

                    print("Copying", required)
                    shutil.copy(required, destination)
                    print("Success")

requires_path property 

requires_path

Path for requires folder.

env 

env(name)

Equivalent to Project.env, except will return the appropriate SharingTier or SharedTier, depending on which is appropriate.

Parameters:

Name Type Description Default
name str

Name of the tier to get.

 required
Source code in cassini/sharing.py 
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
def env(self, name: str) -> Union[SharedTier, SharingTier]:
    """
    Equivalent to `Project.env`, except will return the appropriate `SharingTier` or `SharedTier`, depending
    on which is appropriate.

    Parameters
    ----------
    name: str
        Name of the tier to get.
    """
    if self.project:
        tier = SharingTier.with_project(name=name, sharing_project=self)
        env.update(tier)
        return tier
    else:
        return SharedTier.with_project(name=name, shared_project=self)

__getitem__ 

__getitem__(name)

Equivalent to Project.env, except will return the appropriate SharingTier or SharedTier, depending on which is appropriate.

Parameters:

Name Type Description Default
name str

Name of the tier to get.

 required
Source code in cassini/sharing.py 
643
644
645
646
647
648
649
650
651
652
653
654
655
656
def __getitem__(self, name: str) -> Union[SharedTier, SharingTier]:
    """
    Equivalent to `Project.env`, except will return the appropriate `SharingTier` or `SharedTier`, depending
    on which is appropriate.

    Parameters
    ----------
    name: str
        Name of the tier to get.
    """
    if self.project:
        return SharingTier.with_project(name=name, sharing_project=self)
    else:
        return SharedTier.with_project(name=name, shared_project=self)

make_paths 

make_paths(tier)

Build paths required for sharing a given tier object.

Returns:

Name Type Description
outer Path

The folder the tier data is stored in.
meta_file Path

A path to the meta_file of that tier
frozen_file Path

The path to the frozen.json file, where the tier's attributes and calls are stored.
Source code in cassini/sharing.py 
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
def make_paths(
    self, tier: Union[SharedTier, SharingTier]
) -> Tuple[Path, Path, Path]:
    """
    Build paths required for sharing a given tier object.

    Returns
    -------
    outer: Path
        The folder the tier data is stored in.
    meta_file: Path
        A path to the meta_file of that tier
    frozen_file: Path
        The path to the `frozen.json` file, where the tier's attributes and calls are stored.
    """
    outer = self.location / tier.name

    meta_file = outer / f"{tier.name}.json"
    frozen_file = outer / "frozen.json"

    return outer, meta_file, frozen_file

make_shared 

make_shared()

Create a shared version of this project.

Will create a folder a self.location. Will then iterate all tier objects accessed in this context and serialise them.

Additionally, and files that tiers used access will be copied into the self.requires_path.

Source code in cassini/sharing.py 
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
def make_shared(self) -> None:
    """
    Create a shared version of this project.

    Will create a folder a `self.location`. Will then iterate all `tier` objects accessed in this context
    and serialise them.

    Additionally, and files that tiers used access will be copied into the `self.requires_path`.
    """
    if not self.project:
        raise RuntimeError("Trying to share tiers when not in a sharing context.")

    project = self.project

    path = self.location

    print("Creating shared directory:", path)

    path.mkdir(exist_ok=True)

    print("Success")
    print("Making Requires directory")

    self.requires_path.mkdir(exist_ok=True)

    print("Success")

    for stier in self.shared_tiers:
        print(f"Creating shared version of {stier.name}")

        tier_dir, meta_file, frozen_file = self.make_paths(stier)
        tier_dir.mkdir(exist_ok=True)

        if stier.meta:
            print("Copying Meta")
            shutil.copy(stier.meta.file, meta_file)
            print("Success")

        with open(frozen_file, "w") as fs:
            print("Freezing attributes/ calls")
            stier.dump(fs)
            print("Success")

        print("Making a copy of required files")
        for required in stier.find_paths():
            if required.exists():
                destination = self.requires_path / required.relative_to(
                    project.project_folder
                )
                directory = destination if required.is_dir() else destination.parent
                directory.mkdir(exist_ok=True, parents=True)

                print("Copying", required)
                shutil.copy(required, destination)
                print("Success")