forked from dagger/dagger
/
gen.py
6898 lines (5932 loc) · 201 KB
/
gen.py
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
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
140
141
142
143
144
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
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
477
478
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
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
583
584
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
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Code generated by dagger. DO NOT EDIT.
import warnings
from collections.abc import Callable, Sequence
from dataclasses import dataclass
from ._core import Arg, Root
from ._guards import typecheck
from .base import Enum, Input, Scalar, Type
class CacheVolumeID(Scalar):
"""The `CacheVolumeID` scalar type represents an identifier for an
object of type CacheVolume."""
class ContainerID(Scalar):
"""The `ContainerID` scalar type represents an identifier for an
object of type Container."""
class CurrentModuleID(Scalar):
"""The `CurrentModuleID` scalar type represents an identifier for an
object of type CurrentModule."""
class DirectoryID(Scalar):
"""The `DirectoryID` scalar type represents an identifier for an
object of type Directory."""
class EnvVariableID(Scalar):
"""The `EnvVariableID` scalar type represents an identifier for an
object of type EnvVariable."""
class FieldTypeDefID(Scalar):
"""The `FieldTypeDefID` scalar type represents an identifier for an
object of type FieldTypeDef."""
class FileID(Scalar):
"""The `FileID` scalar type represents an identifier for an object of
type File."""
class FunctionArgID(Scalar):
"""The `FunctionArgID` scalar type represents an identifier for an
object of type FunctionArg."""
class FunctionCallArgValueID(Scalar):
"""The `FunctionCallArgValueID` scalar type represents an identifier
for an object of type FunctionCallArgValue."""
class FunctionCallID(Scalar):
"""The `FunctionCallID` scalar type represents an identifier for an
object of type FunctionCall."""
class FunctionID(Scalar):
"""The `FunctionID` scalar type represents an identifier for an object
of type Function."""
class GeneratedCodeID(Scalar):
"""The `GeneratedCodeID` scalar type represents an identifier for an
object of type GeneratedCode."""
class GitModuleSourceID(Scalar):
"""The `GitModuleSourceID` scalar type represents an identifier for an
object of type GitModuleSource."""
class GitRefID(Scalar):
"""The `GitRefID` scalar type represents an identifier for an object
of type GitRef."""
class GitRepositoryID(Scalar):
"""The `GitRepositoryID` scalar type represents an identifier for an
object of type GitRepository."""
class HostID(Scalar):
"""The `HostID` scalar type represents an identifier for an object of
type Host."""
class InputTypeDefID(Scalar):
"""The `InputTypeDefID` scalar type represents an identifier for an
object of type InputTypeDef."""
class InterfaceTypeDefID(Scalar):
"""The `InterfaceTypeDefID` scalar type represents an identifier for
an object of type InterfaceTypeDef."""
class JSON(Scalar):
"""An arbitrary JSON-encoded value."""
class LabelID(Scalar):
"""The `LabelID` scalar type represents an identifier for an object of
type Label."""
class ListTypeDefID(Scalar):
"""The `ListTypeDefID` scalar type represents an identifier for an
object of type ListTypeDef."""
class LocalModuleSourceID(Scalar):
"""The `LocalModuleSourceID` scalar type represents an identifier for
an object of type LocalModuleSource."""
class ModuleDependencyID(Scalar):
"""The `ModuleDependencyID` scalar type represents an identifier for
an object of type ModuleDependency."""
class ModuleID(Scalar):
"""The `ModuleID` scalar type represents an identifier for an object
of type Module."""
class ModuleSourceID(Scalar):
"""The `ModuleSourceID` scalar type represents an identifier for an
object of type ModuleSource."""
class ModuleSourceViewID(Scalar):
"""The `ModuleSourceViewID` scalar type represents an identifier for
an object of type ModuleSourceView."""
class ObjectTypeDefID(Scalar):
"""The `ObjectTypeDefID` scalar type represents an identifier for an
object of type ObjectTypeDef."""
class Platform(Scalar):
"""The platform config OS and architecture in a Container. The format
is [os]/[platform]/[version] (e.g., "darwin/arm64/v7",
"windows/amd64", "linux/arm64")."""
class PortID(Scalar):
"""The `PortID` scalar type represents an identifier for an object of
type Port."""
class SecretID(Scalar):
"""The `SecretID` scalar type represents an identifier for an object
of type Secret."""
class ServiceID(Scalar):
"""The `ServiceID` scalar type represents an identifier for an object
of type Service."""
class SocketID(Scalar):
"""The `SocketID` scalar type represents an identifier for an object
of type Socket."""
class TerminalID(Scalar):
"""The `TerminalID` scalar type represents an identifier for an object
of type Terminal."""
class TypeDefID(Scalar):
"""The `TypeDefID` scalar type represents an identifier for an object
of type TypeDef."""
class Void(Scalar):
"""The absence of a value. A Null Void is used as a placeholder for
resolvers that do not return anything."""
class CacheSharingMode(Enum):
"""Sharing mode of the cache volume."""
LOCKED = "LOCKED"
"""Shares the cache volume amongst many build pipelines, but will serialize the writes"""
PRIVATE = "PRIVATE"
"""Keeps a cache volume for a single build pipeline"""
SHARED = "SHARED"
"""Shares the cache volume amongst many build pipelines"""
class ImageLayerCompression(Enum):
"""Compression algorithm to use for image layers."""
EStarGZ = "EStarGZ"
Gzip = "Gzip"
Uncompressed = "Uncompressed"
Zstd = "Zstd"
class ImageMediaTypes(Enum):
"""Mediatypes to use in published or exported image metadata."""
DockerMediaTypes = "DockerMediaTypes"
OCIMediaTypes = "OCIMediaTypes"
class ModuleSourceKind(Enum):
"""The kind of module source."""
GIT_SOURCE = "GIT_SOURCE"
LOCAL_SOURCE = "LOCAL_SOURCE"
class NetworkProtocol(Enum):
"""Transport layer network protocol associated to a port."""
TCP = "TCP"
UDP = "UDP"
class TypeDefKind(Enum):
"""Distinguishes the different kinds of TypeDefs."""
BOOLEAN_KIND = "BOOLEAN_KIND"
"""A boolean value."""
INPUT_KIND = "INPUT_KIND"
"""A graphql input type, used only when representing the core API via TypeDefs."""
INTEGER_KIND = "INTEGER_KIND"
"""An integer value."""
INTERFACE_KIND = "INTERFACE_KIND"
"""A named type of functions that can be matched+implemented by other objects+interfaces.
Always paired with an InterfaceTypeDef.
"""
LIST_KIND = "LIST_KIND"
"""A list of values all having the same type.
Always paired with a ListTypeDef.
"""
OBJECT_KIND = "OBJECT_KIND"
"""A named type defined in the GraphQL schema, with fields and functions.
Always paired with an ObjectTypeDef.
"""
STRING_KIND = "STRING_KIND"
"""A string value."""
VOID_KIND = "VOID_KIND"
"""A special kind used to signify that no value is returned.
This is used for functions that have no return value. The outer TypeDef specifying this Kind is always Optional, as the Void is never actually represented.
"""
@dataclass(slots=True)
class BuildArg(Input):
"""Key value object that represents a build argument."""
name: str
"""The build argument name."""
value: str
"""The build argument value."""
@dataclass(slots=True)
class PipelineLabel(Input):
"""Key value object that represents a pipeline label."""
name: str
"""Label name."""
value: str
"""Label value."""
@dataclass(slots=True)
class PortForward(Input):
"""Port forwarding rules for tunneling network traffic."""
backend: int
"""Destination port for traffic."""
frontend: int | None = None
"""Port to expose to clients. If unspecified, a default will be chosen."""
protocol: NetworkProtocol | None = "TCP"
"""Transport layer protocol to use for traffic."""
class CacheVolume(Type):
"""A directory whose contents persist across runs."""
@typecheck
async def id(self) -> CacheVolumeID:
"""A unique identifier for this CacheVolume.
Note
----
This is lazily evaluated, no operation is actually run.
Returns
-------
CacheVolumeID
The `CacheVolumeID` scalar type represents an identifier for an
object of type CacheVolume.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("id", _args)
return await _ctx.execute(CacheVolumeID)
class Container(Type):
"""An OCI-compatible container, also known as a Docker container."""
@typecheck
def as_service(self) -> "Service":
"""Turn the container into a Service.
Be sure to set any exposed ports before this conversion.
"""
_args: list[Arg] = []
_ctx = self._select("asService", _args)
return Service(_ctx)
@typecheck
def as_tarball(
self,
*,
platform_variants: Sequence["Container"] | None = [],
forced_compression: ImageLayerCompression | None = None,
media_types: ImageMediaTypes | None = "OCIMediaTypes",
) -> "File":
"""Returns a File representing the container serialized to a tarball.
Parameters
----------
platform_variants:
Identifiers for other platform specific containers.
Used for multi-platform images.
forced_compression:
Force each layer of the image to use the specified compression
algorithm.
If this is unset, then if a layer already has a compressed blob in
the engine's cache, that will be used (this can result in a mix of
compression algorithms for different layers). If this is unset and
a layer has no compressed blob in the engine's cache, then it will
be compressed using Gzip.
media_types:
Use the specified media types for the image's layers.
Defaults to OCI, which is largely compatible with most recent
container runtimes, but Docker may be needed for older runtimes
without OCI support.
"""
_args = [
Arg("platformVariants", platform_variants, []),
Arg("forcedCompression", forced_compression, None),
Arg("mediaTypes", media_types, "OCIMediaTypes"),
]
_ctx = self._select("asTarball", _args)
return File(_ctx)
@typecheck
def build(
self,
context: "Directory",
*,
dockerfile: str | None = "Dockerfile",
target: str | None = "",
build_args: Sequence[BuildArg] | None = [],
secrets: Sequence["Secret"] | None = [],
) -> "Container":
"""Initializes this container from a Dockerfile build.
Parameters
----------
context:
Directory context used by the Dockerfile.
dockerfile:
Path to the Dockerfile to use.
target:
Target build stage to build.
build_args:
Additional build arguments.
secrets:
Secrets to pass to the build.
They will be mounted at /run/secrets/[secret-name] in the build
container
They can be accessed in the Dockerfile using the "secret" mount
type and mount path /run/secrets/[secret-name], e.g. RUN
--mount=type=secret,id=my-secret curl
[http://example.com?token=$(cat /run/secrets/my-
secret)](http://example.com?token=$(cat /run/secrets/my-secret))
"""
_args = [
Arg("context", context),
Arg("dockerfile", dockerfile, "Dockerfile"),
Arg("target", target, ""),
Arg("buildArgs", build_args, []),
Arg("secrets", secrets, []),
]
_ctx = self._select("build", _args)
return Container(_ctx)
@typecheck
async def default_args(self) -> list[str]:
"""Retrieves default arguments for future commands.
Returns
-------
list[str]
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("defaultArgs", _args)
return await _ctx.execute(list[str])
@typecheck
def directory(self, path: str) -> "Directory":
"""Retrieves a directory at the given path.
Mounts are included.
Parameters
----------
path:
The path of the directory to retrieve (e.g., "./src").
"""
_args = [
Arg("path", path),
]
_ctx = self._select("directory", _args)
return Directory(_ctx)
@typecheck
async def entrypoint(self) -> list[str]:
"""Retrieves entrypoint to be prepended to the arguments of all commands.
Returns
-------
list[str]
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("entrypoint", _args)
return await _ctx.execute(list[str])
@typecheck
async def env_variable(self, name: str) -> str | None:
"""Retrieves the value of the specified environment variable.
Parameters
----------
name:
The name of the environment variable to retrieve (e.g., "PATH").
Returns
-------
str | None
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args = [
Arg("name", name),
]
_ctx = self._select("envVariable", _args)
return await _ctx.execute(str | None)
@typecheck
async def env_variables(self) -> list["EnvVariable"]:
"""Retrieves the list of environment variables passed to commands."""
_args: list[Arg] = []
_ctx = self._select("envVariables", _args)
_ctx = EnvVariable(_ctx)._select("id", [])
@dataclass
class Response:
id: EnvVariableID
_ids = await _ctx.execute(list[Response])
return [
EnvVariable(
Client.from_context(_ctx)._select(
"loadEnvVariableFromID",
[Arg("id", v.id)],
)
)
for v in _ids
]
@typecheck
def experimental_with_all_gp_us(self) -> "Container":
"""EXPERIMENTAL API! Subject to change/removal at any time.
Configures all available GPUs on the host to be accessible to this
container.
This currently works for Nvidia devices only.
"""
_args: list[Arg] = []
_ctx = self._select("experimentalWithAllGPUs", _args)
return Container(_ctx)
@typecheck
def experimental_with_gpu(self, devices: Sequence[str]) -> "Container":
"""EXPERIMENTAL API! Subject to change/removal at any time.
Configures the provided list of devices to be accesible to this
container.
This currently works for Nvidia devices only.
Parameters
----------
devices:
List of devices to be accessible to this container.
"""
_args = [
Arg("devices", devices),
]
_ctx = self._select("experimentalWithGPU", _args)
return Container(_ctx)
@typecheck
async def export(
self,
path: str,
*,
platform_variants: Sequence["Container"] | None = [],
forced_compression: ImageLayerCompression | None = None,
media_types: ImageMediaTypes | None = "OCIMediaTypes",
) -> bool:
"""Writes the container as an OCI tarball to the destination file path on
the host.
Return true on success.
It can also export platform variants.
Parameters
----------
path:
Host's destination path (e.g., "./tarball").
Path can be relative to the engine's workdir or absolute.
platform_variants:
Identifiers for other platform specific containers.
Used for multi-platform image.
forced_compression:
Force each layer of the exported image to use the specified
compression algorithm.
If this is unset, then if a layer already has a compressed blob in
the engine's cache, that will be used (this can result in a mix of
compression algorithms for different layers). If this is unset and
a layer has no compressed blob in the engine's cache, then it will
be compressed using Gzip.
media_types:
Use the specified media types for the exported image's layers.
Defaults to OCI, which is largely compatible with most recent
container runtimes, but Docker may be needed for older runtimes
without OCI support.
Returns
-------
bool
The `Boolean` scalar type represents `true` or `false`.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args = [
Arg("path", path),
Arg("platformVariants", platform_variants, []),
Arg("forcedCompression", forced_compression, None),
Arg("mediaTypes", media_types, "OCIMediaTypes"),
]
_ctx = self._select("export", _args)
return await _ctx.execute(bool)
@typecheck
async def exposed_ports(self) -> list["Port"]:
"""Retrieves the list of exposed ports.
This includes ports already exposed by the image, even if not
explicitly added with dagger.
"""
_args: list[Arg] = []
_ctx = self._select("exposedPorts", _args)
_ctx = Port(_ctx)._select("id", [])
@dataclass
class Response:
id: PortID
_ids = await _ctx.execute(list[Response])
return [
Port(
Client.from_context(_ctx)._select(
"loadPortFromID",
[Arg("id", v.id)],
)
)
for v in _ids
]
@typecheck
def file(self, path: str) -> "File":
"""Retrieves a file at the given path.
Mounts are included.
Parameters
----------
path:
The path of the file to retrieve (e.g., "./README.md").
"""
_args = [
Arg("path", path),
]
_ctx = self._select("file", _args)
return File(_ctx)
@typecheck
def from_(self, address: str) -> "Container":
"""Initializes this container from a pulled base image.
Parameters
----------
address:
Image's address from its registry.
Formatted as [host]/[user]/[repo]:[tag] (e.g.,
"docker.io/dagger/dagger:main").
"""
_args = [
Arg("address", address),
]
_ctx = self._select("from", _args)
return Container(_ctx)
@typecheck
async def id(self) -> ContainerID:
"""A unique identifier for this Container.
Note
----
This is lazily evaluated, no operation is actually run.
Returns
-------
ContainerID
The `ContainerID` scalar type represents an identifier for an
object of type Container.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("id", _args)
return await _ctx.execute(ContainerID)
@typecheck
async def image_ref(self) -> str:
"""The unique image reference which can only be retrieved immediately
after the 'Container.From' call.
Returns
-------
str
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("imageRef", _args)
return await _ctx.execute(str)
@typecheck
def import_(
self,
source: "File",
*,
tag: str | None = "",
) -> "Container":
"""Reads the container from an OCI tarball.
Parameters
----------
source:
File to read the container from.
tag:
Identifies the tag to import from the archive, if the archive
bundles multiple tags.
"""
_args = [
Arg("source", source),
Arg("tag", tag, ""),
]
_ctx = self._select("import", _args)
return Container(_ctx)
@typecheck
async def label(self, name: str) -> str | None:
"""Retrieves the value of the specified label.
Parameters
----------
name:
The name of the label (e.g.,
"org.opencontainers.artifact.created").
Returns
-------
str | None
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args = [
Arg("name", name),
]
_ctx = self._select("label", _args)
return await _ctx.execute(str | None)
@typecheck
async def labels(self) -> list["Label"]:
"""Retrieves the list of labels passed to container."""
_args: list[Arg] = []
_ctx = self._select("labels", _args)
_ctx = Label(_ctx)._select("id", [])
@dataclass
class Response:
id: LabelID
_ids = await _ctx.execute(list[Response])
return [
Label(
Client.from_context(_ctx)._select(
"loadLabelFromID",
[Arg("id", v.id)],
)
)
for v in _ids
]
@typecheck
async def mounts(self) -> list[str]:
"""Retrieves the list of paths where a directory is mounted.
Returns
-------
list[str]
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("mounts", _args)
return await _ctx.execute(list[str])
@typecheck
def pipeline(
self,
name: str,
*,
description: str | None = "",
labels: Sequence[PipelineLabel] | None = [],
) -> "Container":
"""Creates a named sub-pipeline.
Parameters
----------
name:
Name of the sub-pipeline.
description:
Description of the sub-pipeline.
labels:
Labels to apply to the sub-pipeline.
"""
_args = [
Arg("name", name),
Arg("description", description, ""),
Arg("labels", labels, []),
]
_ctx = self._select("pipeline", _args)
return Container(_ctx)
@typecheck
async def platform(self) -> Platform:
"""The platform this container executes and publishes as.
Returns
-------
Platform
The platform config OS and architecture in a Container. The
format is [os]/[platform]/[version] (e.g., "darwin/arm64/v7",
"windows/amd64", "linux/arm64").
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("platform", _args)
return await _ctx.execute(Platform)
@typecheck
async def publish(
self,
address: str,
*,
platform_variants: Sequence["Container"] | None = [],
forced_compression: ImageLayerCompression | None = None,
media_types: ImageMediaTypes | None = "OCIMediaTypes",
) -> str:
"""Publishes this container as a new image to the specified address.
Publish returns a fully qualified ref.
It can also publish platform variants.
Parameters
----------
address:
Registry's address to publish the image to.
Formatted as [host]/[user]/[repo]:[tag] (e.g.
"docker.io/dagger/dagger:main").
platform_variants:
Identifiers for other platform specific containers.
Used for multi-platform image.
forced_compression:
Force each layer of the published image to use the specified
compression algorithm.
If this is unset, then if a layer already has a compressed blob in
the engine's cache, that will be used (this can result in a mix of
compression algorithms for different layers). If this is unset and
a layer has no compressed blob in the engine's cache, then it will
be compressed using Gzip.
media_types:
Use the specified media types for the published image's layers.
Defaults to OCI, which is largely compatible with most recent
registries, but Docker may be needed for older registries without
OCI support.
Returns
-------
str
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args = [
Arg("address", address),
Arg("platformVariants", platform_variants, []),
Arg("forcedCompression", forced_compression, None),
Arg("mediaTypes", media_types, "OCIMediaTypes"),
]
_ctx = self._select("publish", _args)
return await _ctx.execute(str)
@typecheck
def rootfs(self) -> "Directory":
"""Retrieves this container's root filesystem. Mounts are not included."""
_args: list[Arg] = []
_ctx = self._select("rootfs", _args)
return Directory(_ctx)
@typecheck
async def stderr(self) -> str:
"""The error stream of the last executed command.
Will execute default command if none is set, or error if there's no
default.
Returns
-------
str
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------
ExecuteTimeoutError
If the time to execute the query exceeds the configured timeout.
QueryError
If the API returns an error.
"""
_args: list[Arg] = []
_ctx = self._select("stderr", _args)
return await _ctx.execute(str)
@typecheck
async def stdout(self) -> str:
"""The output stream of the last executed command.
Will execute default command if none is set, or error if there's no
default.
Returns
-------
str
The `String` scalar type represents textual data, represented as
UTF-8 character sequences. The String type is most often used by
GraphQL to represent free-form human-readable text.
Raises
------