File: UltimakerFormatPackage.py

package info (click to toggle)
libcharon 5.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 576 kB
  • sloc: python: 1,575; sh: 388; makefile: 3
file content (53 lines) | stat: -rwxr-xr-x 2,166 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
# Copyright (c) 2018 Ultimaker B.V.
# libCharon is released under the terms of the LGPLv3 or higher.
from collections import OrderedDict

from Charon.OpenMode import OpenMode
from Charon.filetypes.GCodeFile import GCodeFile
from Charon.filetypes.OpenPackagingConvention import OpenPackagingConvention


##  A container file type that contains multiple 3D-printing related files that belong together.
class UltimakerFormatPackage(OpenPackagingConvention):

    # Where the global metadata file is.
    _global_metadata_file = "/Metadata/UFP_Global.json"

    # Unique identifier of the relationship type that relates UFP metadata to files.
    _metadata_relationship_type = "http://schemas.ultimaker.org/package/2018/relationships/ufp_metadata"

    # Where the global metadata file is.
    global_metadata_file = "/Metadata/UFP_Global.json"

    # Unique identifier of the relationship type that relates UFP metadata to files.
    metadata_relationship_type = "http://schemas.ultimaker.org/package/2018/relationships/ufp_metadata"

    # Virtual path aliases. Keys are regex. Order matters!
    _aliases = OrderedDict([
        (r"^/preview/default", "/Metadata/thumbnail.png"),
        (r"^/preview", "/Metadata/thumbnail.png"),
        (r"^/toolpath/default", "/3D/model.gcode"),
        (r"^/toolpath", "/3D/model.gcode"),
    ])

    mime_type = "application/x-ufp"

    ##  Initialises the fields of this class.
    def __init__(self):
        super().__init__()

    ##  When loading a file, read its metadata from the archive.
    #
    #   This depends on the relations! Read the relations first!
    def _readMetadata(self) -> None:
        super()._readMetadata()
        if self._mode != OpenMode.WriteOnly and not self.getMetadata("/3D/model.gcode"):
            try:
                # Check if the G-code file actually exists in the package.
                self._zipfile.getinfo("/3D/model.gcode")
            except KeyError:
                return

            gcode_stream = self._zipfile.open("/3D/model.gcode")
            header_data = GCodeFile.parseHeader(gcode_stream, prefix="/3D/model.gcode/")
            self._metadata.update(header_data)