zoo-kcl 0.3.60__cp313-cp313-win_amd64.whl → 0.3.120__cp313-cp313-win_amd64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of zoo-kcl might be problematic. Click here for more details.

kcl/__init__.pyi ADDED
@@ -0,0 +1,761 @@
1
+ # This file is automatically generated by pyo3_stub_gen
2
+ # ruff: noqa: E501, F401
3
+
4
+ import builtins
5
+ import typing
6
+ from enum import Enum
7
+
8
+ class AxisDirectionPair:
9
+ r"""
10
+ An [`Axis`] paired with a [`Direction`].
11
+ """
12
+ ...
13
+
14
+ class Base64Data:
15
+ r"""
16
+ A container for binary that should be base64 encoded in serialisation. In reverse
17
+ when deserializing, will decode from many different types of base64 possible.
18
+ """
19
+ ...
20
+
21
+ class CameraLookAt:
22
+ def __new__(cls, vantage:Point3d, center:Point3d, up:Point3d) -> CameraLookAt: ...
23
+
24
+ class Discovered:
25
+ r"""
26
+ Specific discovered lint rule Violation of a particular Finding.
27
+ """
28
+ @property
29
+ def finding(self) -> Finding: ...
30
+ @property
31
+ def description(self) -> builtins.str: ...
32
+ @property
33
+ def pos(self) -> tuple[builtins.int, builtins.int]: ...
34
+ @property
35
+ def overridden(self) -> builtins.bool: ...
36
+
37
+ class DxfExportOptions:
38
+ r"""
39
+ Options for exporting DXF format.
40
+ """
41
+ def __new__(cls) -> DxfExportOptions:
42
+ r"""
43
+ Set the options to their defaults.
44
+ """
45
+
46
+ class ExportFile:
47
+ r"""
48
+ A file to be exported to the client.
49
+ """
50
+ @property
51
+ def contents(self) -> builtins.list[builtins.int]: ...
52
+ @property
53
+ def name(self) -> builtins.str: ...
54
+
55
+ class FbxExportOptions:
56
+ r"""
57
+ Options for exporting FBX.
58
+ """
59
+ def __new__(cls) -> FbxExportOptions:
60
+ r"""
61
+ Set the options to their defaults.
62
+ """
63
+
64
+ class FbxImportOptions:
65
+ r"""
66
+ Options for importing FBX.
67
+ """
68
+ def __new__(cls) -> FbxImportOptions:
69
+ r"""
70
+ Set the options to their defaults.
71
+ """
72
+
73
+ class Finding:
74
+ r"""
75
+ Abstract lint problem type.
76
+ """
77
+ @property
78
+ def code(self) -> builtins.str: ...
79
+ @property
80
+ def title(self) -> builtins.str: ...
81
+ @property
82
+ def description(self) -> builtins.str: ...
83
+ @property
84
+ def experimental(self) -> builtins.bool: ...
85
+ @property
86
+ def family(self) -> builtins.str: ...
87
+
88
+ class FixedLints:
89
+ r"""
90
+ Result from linting and fixing automatically.
91
+ Shows the new code after applying fixes,
92
+ and any lints that couldn't be automatically applied.
93
+ """
94
+ ...
95
+
96
+ class GltfExportOptions:
97
+ r"""
98
+ Options for exporting glTF 2.0.
99
+ """
100
+ def __new__(cls) -> GltfExportOptions:
101
+ r"""
102
+ Set the options to their defaults.
103
+ """
104
+
105
+ class GltfImportOptions:
106
+ r"""
107
+ Options for importing glTF 2.0.
108
+ """
109
+ def __new__(cls) -> GltfImportOptions:
110
+ r"""
111
+ Set the options to their defaults.
112
+ """
113
+
114
+ class InputFormat3d:
115
+ r"""
116
+ Input format specifier.
117
+ """
118
+ class Fbx(InputFormat3d):
119
+ r"""
120
+ Autodesk Filmbox (FBX) format.
121
+ """
122
+ __match_args__ = ("_0",)
123
+ @property
124
+ def _0(self) -> FbxImportOptions: ...
125
+ def __new__(cls, _0:FbxImportOptions) -> InputFormat3d.Fbx: ...
126
+ def __len__(self) -> builtins.int: ...
127
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
128
+
129
+ class Gltf(InputFormat3d):
130
+ r"""
131
+ Binary glTF 2.0.
132
+ We refer to this as glTF since that is how our customers refer to it,
133
+ but this can also import binary glTF (glb).
134
+ """
135
+ __match_args__ = ("_0",)
136
+ @property
137
+ def _0(self) -> GltfImportOptions: ...
138
+ def __new__(cls, _0:GltfImportOptions) -> InputFormat3d.Gltf: ...
139
+ def __len__(self) -> builtins.int: ...
140
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
141
+
142
+ class Obj(InputFormat3d):
143
+ r"""
144
+ Wavefront OBJ format.
145
+ """
146
+ __match_args__ = ("_0",)
147
+ @property
148
+ def _0(self) -> ObjImportOptions: ...
149
+ def __new__(cls, _0:ObjImportOptions) -> InputFormat3d.Obj: ...
150
+ def __len__(self) -> builtins.int: ...
151
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
152
+
153
+ class Ply(InputFormat3d):
154
+ r"""
155
+ The PLY Polygon File Format.
156
+ """
157
+ __match_args__ = ("_0",)
158
+ @property
159
+ def _0(self) -> PlyImportOptions: ...
160
+ def __new__(cls, _0:PlyImportOptions) -> InputFormat3d.Ply: ...
161
+ def __len__(self) -> builtins.int: ...
162
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
163
+
164
+ class Sldprt(InputFormat3d):
165
+ r"""
166
+ SolidWorks part (SLDPRT) format.
167
+ """
168
+ __match_args__ = ("_0",)
169
+ @property
170
+ def _0(self) -> SldprtImportOptions: ...
171
+ def __new__(cls, _0:SldprtImportOptions) -> InputFormat3d.Sldprt: ...
172
+ def __len__(self) -> builtins.int: ...
173
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
174
+
175
+ class Step(InputFormat3d):
176
+ r"""
177
+ ISO 10303-21 (STEP) format.
178
+ """
179
+ __match_args__ = ("_0",)
180
+ @property
181
+ def _0(self) -> StepImportOptions: ...
182
+ def __new__(cls, _0:StepImportOptions) -> InputFormat3d.Step: ...
183
+ def __len__(self) -> builtins.int: ...
184
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
185
+
186
+ class Stl(InputFormat3d):
187
+ r"""
188
+ **ST**ereo**L**ithography format.
189
+ """
190
+ __match_args__ = ("_0",)
191
+ @property
192
+ def _0(self) -> StlImportOptions: ...
193
+ def __new__(cls, _0:StlImportOptions) -> InputFormat3d.Stl: ...
194
+ def __len__(self) -> builtins.int: ...
195
+ def __getitem__(self, key:builtins.int) -> typing.Any: ...
196
+
197
+ ...
198
+
199
+ class ObjExportOptions:
200
+ r"""
201
+ Options for exporting OBJ.
202
+ """
203
+ def __new__(cls) -> ObjExportOptions:
204
+ r"""
205
+ Set the options to their defaults.
206
+ """
207
+
208
+ class ObjImportOptions:
209
+ r"""
210
+ Options for importing OBJ.
211
+ """
212
+ def __new__(cls) -> ObjImportOptions:
213
+ r"""
214
+ Set the options to their defaults.
215
+ """
216
+
217
+ class PlyExportOptions:
218
+ r"""
219
+ Options for exporting PLY.
220
+ """
221
+ def __new__(cls) -> PlyExportOptions:
222
+ r"""
223
+ Set the options to their defaults.
224
+ """
225
+
226
+ class PlyImportOptions:
227
+ r"""
228
+ Options for importing PLY.
229
+ """
230
+ def __new__(cls) -> PlyImportOptions:
231
+ r"""
232
+ Set the options to their defaults.
233
+ """
234
+
235
+ class Point3d:
236
+ def __new__(cls, x:builtins.float, y:builtins.float, z:builtins.float) -> Point3d:
237
+ r"""
238
+ Create a new point from its 3 components x, y and z
239
+ All of them take floating point values.
240
+ """
241
+
242
+ class RawFile:
243
+ r"""
244
+ A raw file with unencoded contents to be passed over binary websockets.
245
+ When raw files come back for exports it is sent as binary/bson, not text/json.
246
+ """
247
+ @property
248
+ def contents(self) -> builtins.list[builtins.int]: ...
249
+ @property
250
+ def name(self) -> builtins.str: ...
251
+
252
+ class SldprtImportOptions:
253
+ r"""
254
+ Options for importing SolidWorks parts.
255
+ """
256
+ def __new__(cls) -> SldprtImportOptions:
257
+ r"""
258
+ Set the options to their defaults.
259
+ """
260
+
261
+ class SnapshotOptions:
262
+ r"""
263
+ Customize a snapshot.
264
+ """
265
+ def __new__(cls, camera:typing.Optional[CameraLookAt], padding:builtins.float) -> SnapshotOptions:
266
+ r"""
267
+ Takes a kcl.CameraLookAt, and a padding number.
268
+ """
269
+ @staticmethod
270
+ def isometric_view(padding:builtins.float) -> SnapshotOptions:
271
+ r"""
272
+ Takes a padding number.
273
+ """
274
+
275
+ class StepExportOptions:
276
+ r"""
277
+ Options for exporting STEP format.
278
+ """
279
+ def __new__(cls) -> StepExportOptions:
280
+ r"""
281
+ Set the options to their defaults.
282
+ """
283
+
284
+ class StepImportOptions:
285
+ r"""
286
+ Options for importing STEP format.
287
+ """
288
+ def __new__(cls) -> StepImportOptions:
289
+ r"""
290
+ Set the options to their defaults.
291
+ """
292
+
293
+ class StlExportOptions:
294
+ r"""
295
+ Options for exporting STL.
296
+ """
297
+ def __new__(cls) -> StlExportOptions:
298
+ r"""
299
+ Set the options to their defaults.
300
+ """
301
+
302
+ class StlImportOptions:
303
+ r"""
304
+ Options for importing STL.
305
+ """
306
+ ...
307
+
308
+ class System:
309
+ r"""
310
+ Co-ordinate system definition.
311
+
312
+ The `up` axis must be orthogonal to the `forward` axis.
313
+
314
+ See [cglearn.eu] for background reading.
315
+
316
+ [cglearn.eu](https://cglearn.eu/pub/computer-graphics/introduction-to-geometry#material-coordinate-systems-1)
317
+ """
318
+ ...
319
+
320
+ class Axis(Enum):
321
+ r"""
322
+ Co-ordinate axis specifier.
323
+
324
+ See [cglearn.eu] for background reading.
325
+
326
+ [cglearn.eu]: https://cglearn.eu/pub/computer-graphics/introduction-to-geometry#material-coordinate-systems-1
327
+ """
328
+ Y = ...
329
+ r"""
330
+ 'Y' axis.
331
+ """
332
+ Z = ...
333
+ r"""
334
+ 'Z' axis.
335
+ """
336
+
337
+ class Direction(Enum):
338
+ r"""
339
+ Specifies the sign of a co-ordinate axis.
340
+ """
341
+ Positive = ...
342
+ r"""
343
+ Increasing numbers.
344
+ """
345
+ Negative = ...
346
+ r"""
347
+ Decreasing numbers.
348
+ """
349
+
350
+ class DxfStorage(Enum):
351
+ r"""
352
+ Export storage.
353
+ """
354
+ Ascii = ...
355
+ r"""
356
+ Plaintext encoding.
357
+
358
+ This is the default setting.
359
+ """
360
+ Binary = ...
361
+ r"""
362
+ Binary encoding.
363
+ """
364
+
365
+ class FbxStorage(Enum):
366
+ r"""
367
+ Describes the storage format of an FBX file.
368
+ """
369
+ Ascii = ...
370
+ r"""
371
+ ASCII FBX encoding.
372
+ """
373
+ Binary = ...
374
+ r"""
375
+ Binary FBX encoding.
376
+ """
377
+
378
+ class FileExportFormat(Enum):
379
+ r"""
380
+ The valid types of output file formats.
381
+ """
382
+ Fbx = ...
383
+ r"""
384
+ Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
385
+ """
386
+ Glb = ...
387
+ r"""
388
+ Binary glTF 2.0.
389
+
390
+ This is a single binary with .glb extension.
391
+
392
+ This is better if you want a compressed format as opposed to the human readable
393
+ glTF that lacks compression.
394
+ """
395
+ Gltf = ...
396
+ r"""
397
+ glTF 2.0.
398
+ Embedded glTF 2.0 (pretty printed).
399
+
400
+ Single JSON file with .gltf extension binary data encoded as
401
+ base64 data URIs.
402
+
403
+ The JSON contents are pretty printed.
404
+
405
+ It is human readable, single file, and you can view the
406
+ diff easily in a git commit.
407
+ """
408
+ Obj = ...
409
+ r"""
410
+ The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file>
411
+ It may or may not have an an attached material (mtl // mtllib) within the file,
412
+ but we interact with it as if it does not.
413
+ """
414
+ Ply = ...
415
+ r"""
416
+ The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
417
+ """
418
+ Step = ...
419
+ r"""
420
+ The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
421
+ """
422
+ Stl = ...
423
+ r"""
424
+ The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
425
+ """
426
+
427
+ class FindingFamily(Enum):
428
+ r"""
429
+ Lint families such as style or correctness.
430
+ """
431
+ Style = ...
432
+ r"""
433
+ KCL style guidelines, e.g. identifier casing.
434
+ """
435
+ Correctness = ...
436
+ r"""
437
+ The user is probably doing something incorrect or unintended.
438
+ """
439
+ Simplify = ...
440
+ r"""
441
+ The user has expressed something in a complex way that could be simplified.
442
+ """
443
+
444
+ class GltfStorage(Enum):
445
+ r"""
446
+ Describes the storage format of a glTF 2.0 scene.
447
+ """
448
+ Binary = ...
449
+ r"""
450
+ Binary glTF 2.0.
451
+
452
+ This is a single binary with .glb extension.
453
+ """
454
+ Standard = ...
455
+ r"""
456
+ Standard glTF 2.0.
457
+
458
+ This is a JSON file with .gltf extension paired with a separate
459
+ binary blob file with .bin extension.
460
+ """
461
+ Embedded = ...
462
+ r"""
463
+ Embedded glTF 2.0.
464
+
465
+ Single JSON file with .gltf extension binary data encoded as
466
+ base64 data URIs.
467
+
468
+ This is the default setting.
469
+ """
470
+
471
+ class ImageFormat(Enum):
472
+ r"""
473
+ Enum containing the variety of image formats snapshots may be exported to.
474
+ """
475
+ Png = ...
476
+ r"""
477
+ .png format
478
+ """
479
+ Jpeg = ...
480
+ r"""
481
+ .jpeg format
482
+ """
483
+
484
+ class PlyStorage(Enum):
485
+ r"""
486
+ The storage for the output PLY file.
487
+ """
488
+ Ascii = ...
489
+ r"""
490
+ Write numbers in their ascii representation (e.g. -13, 6.28, etc.). Properties are separated by spaces and elements are separated by line breaks.
491
+ """
492
+ BinaryLittleEndian = ...
493
+ r"""
494
+ Encode payload as binary using little endian.
495
+ """
496
+ BinaryBigEndian = ...
497
+ r"""
498
+ Encode payload as binary using big endian.
499
+ """
500
+
501
+ class StlStorage(Enum):
502
+ r"""
503
+ Export storage.
504
+ """
505
+ Ascii = ...
506
+ r"""
507
+ Plaintext encoding.
508
+ """
509
+ Binary = ...
510
+ r"""
511
+ Binary STL encoding.
512
+
513
+ This is the default setting.
514
+ """
515
+
516
+ class UnitAngle(Enum):
517
+ r"""
518
+ The valid types of angle formats.
519
+ """
520
+ Degrees = ...
521
+ r"""
522
+ Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
523
+ """
524
+ Radians = ...
525
+ r"""
526
+ Radians <https://en.wikipedia.org/wiki/Radian>
527
+ """
528
+
529
+ class UnitArea(Enum):
530
+ r"""
531
+ The valid types of area units.
532
+ """
533
+ SquareCentimeters = ...
534
+ r"""
535
+ Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
536
+ """
537
+ SquareDecimeters = ...
538
+ r"""
539
+ Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
540
+ """
541
+ SquareFeet = ...
542
+ r"""
543
+ Square feet <https://en.wikipedia.org/wiki/Square_foot>
544
+ """
545
+ SquareInches = ...
546
+ r"""
547
+ Square inches <https://en.wikipedia.org/wiki/Square_inch>
548
+ """
549
+ SquareKilometers = ...
550
+ r"""
551
+ Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
552
+ """
553
+ SquareMeters = ...
554
+ r"""
555
+ Square meters <https://en.wikipedia.org/wiki/Square_meter>
556
+ """
557
+ SquareMillimeters = ...
558
+ r"""
559
+ Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
560
+ """
561
+ SquareYards = ...
562
+ r"""
563
+ Square yards <https://en.wikipedia.org/wiki/Square_mile>
564
+ """
565
+
566
+ class UnitDensity(Enum):
567
+ r"""
568
+ The valid types for density units.
569
+ """
570
+ PoundsPerCubicFeet = ...
571
+ r"""
572
+ Pounds per cubic feet.
573
+ """
574
+ KilogramsPerCubicMeter = ...
575
+ r"""
576
+ Kilograms per cubic meter.
577
+ """
578
+
579
+ class UnitLength(Enum):
580
+ r"""
581
+ The valid types of length units.
582
+ """
583
+ Centimeters = ...
584
+ r"""
585
+ Centimeters <https://en.wikipedia.org/wiki/Centimeter>
586
+ """
587
+ Feet = ...
588
+ r"""
589
+ Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
590
+ """
591
+ Inches = ...
592
+ r"""
593
+ Inches <https://en.wikipedia.org/wiki/Inch>
594
+ """
595
+ Meters = ...
596
+ r"""
597
+ Meters <https://en.wikipedia.org/wiki/Meter>
598
+ """
599
+ Millimeters = ...
600
+ r"""
601
+ Millimeters <https://en.wikipedia.org/wiki/Millimeter>
602
+ """
603
+ Yards = ...
604
+ r"""
605
+ Yards <https://en.wikipedia.org/wiki/Yard>
606
+ """
607
+
608
+ class UnitMass(Enum):
609
+ r"""
610
+ The valid types of mass units.
611
+ """
612
+ Grams = ...
613
+ r"""
614
+ Grams <https://en.wikipedia.org/wiki/Gram>
615
+ """
616
+ Kilograms = ...
617
+ r"""
618
+ Kilograms <https://en.wikipedia.org/wiki/Kilogram>
619
+ """
620
+ Pounds = ...
621
+ r"""
622
+ Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
623
+ """
624
+
625
+ class UnitVolume(Enum):
626
+ r"""
627
+ The valid types of volume units.
628
+ """
629
+ CubicCentimeters = ...
630
+ r"""
631
+ Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>
632
+ """
633
+ CubicFeet = ...
634
+ r"""
635
+ Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>
636
+ """
637
+ CubicInches = ...
638
+ r"""
639
+ Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>
640
+ """
641
+ CubicMeters = ...
642
+ r"""
643
+ Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>
644
+ """
645
+ CubicYards = ...
646
+ r"""
647
+ Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>
648
+ """
649
+ FluidOunces = ...
650
+ r"""
651
+ US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>
652
+ """
653
+ Gallons = ...
654
+ r"""
655
+ US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>
656
+ """
657
+ Liters = ...
658
+ r"""
659
+ Liters (l) <https://en.wikipedia.org/wiki/Litre>
660
+ """
661
+ Milliliters = ...
662
+ r"""
663
+ Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
664
+ """
665
+
666
+ async def execute(path:builtins.str) -> None:
667
+ r"""
668
+ Execute the kcl code from a file path.
669
+ """
670
+
671
+ async def execute_and_export(path:builtins.str, export_format:FileExportFormat) -> builtins.list[RawFile]:
672
+ r"""
673
+ Execute a kcl file and export it to a specific file format.
674
+ """
675
+
676
+ async def execute_and_snapshot(path:builtins.str, image_format:ImageFormat) -> builtins.list[builtins.int]:
677
+ r"""
678
+ Execute a kcl file and snapshot it in a specific format.
679
+ """
680
+
681
+ async def execute_and_snapshot_views(path:builtins.str, image_format:ImageFormat, snapshot_options:typing.Sequence[SnapshotOptions]) -> builtins.list[builtins.list[builtins.int]]: ...
682
+
683
+ async def execute_code(code:builtins.str) -> None:
684
+ r"""
685
+ Execute the kcl code.
686
+ """
687
+
688
+ async def execute_code_and_export(code:builtins.str, export_format:FileExportFormat) -> builtins.list[RawFile]:
689
+ r"""
690
+ Execute the kcl code and export it to a specific file format.
691
+ """
692
+
693
+ async def execute_code_and_snapshot(code:builtins.str, image_format:ImageFormat) -> builtins.list[builtins.int]:
694
+ r"""
695
+ Execute the kcl code and snapshot it in a specific format.
696
+ """
697
+
698
+ async def execute_code_and_snapshot_views(code:builtins.str, image_format:ImageFormat, snapshot_options:typing.Sequence[SnapshotOptions]) -> builtins.list[builtins.list[builtins.int]]:
699
+ r"""
700
+ Execute the kcl code and snapshot it in a specific format.
701
+ Returns one image for each camera angle you provide.
702
+ If you don't provide any camera angles, a default head-on camera angle will be used.
703
+ """
704
+
705
+ def format(code:builtins.str) -> builtins.str:
706
+ r"""
707
+ Format the kcl code. This will return the formatted code.
708
+ """
709
+
710
+ async def format_dir(dir:builtins.str) -> None:
711
+ r"""
712
+ Format a whole directory of kcl code.
713
+ """
714
+
715
+ async def import_and_snapshot(filepaths:typing.Sequence[builtins.str], format:InputFormat3d, image_format:ImageFormat) -> builtins.list[builtins.int]: ...
716
+
717
+ async def import_and_snapshot_views(filepaths:typing.Sequence[builtins.str], format:InputFormat3d, image_format:ImageFormat, snapshot_options:typing.Sequence[SnapshotOptions]) -> builtins.list[builtins.list[builtins.int]]: ...
718
+
719
+ def lint(code:builtins.str) -> builtins.list[Discovered]:
720
+ r"""
721
+ Lint the kcl code.
722
+ """
723
+
724
+ def lint_and_fix_all(code:builtins.str) -> FixedLints:
725
+ r"""
726
+ Lint the kcl code. Fix any lints that can be fixed with automatic suggestions.
727
+ Returns any unfixed lints.
728
+ """
729
+
730
+ def lint_and_fix_families(code:builtins.str, families_to_fix:typing.Sequence[FindingFamily]) -> FixedLints:
731
+ r"""
732
+ Lint the kcl code. Fix any lints that can be fixed with automatic suggestions,
733
+ and are in the list of families to fix.
734
+ Returns any unfixed lints.
735
+ """
736
+
737
+ async def mock_execute(path:builtins.str) -> builtins.bool:
738
+ r"""
739
+ Mock execute the kcl code from a file path.
740
+ """
741
+
742
+ async def mock_execute_code(code:builtins.str) -> builtins.bool:
743
+ r"""
744
+ Mock execute the kcl code.
745
+ """
746
+
747
+ async def parse(path:builtins.str) -> builtins.bool:
748
+ r"""
749
+ Parse the kcl code from a file path.
750
+ """
751
+
752
+ def parse_code(code:builtins.str) -> builtins.bool:
753
+ r"""
754
+ Parse the kcl code.
755
+ """
756
+
757
+ def relevant_file_extensions() -> builtins.list[builtins.str]:
758
+ r"""
759
+ Get the allowed relevant file extensions (imports + kcl).
760
+ """
761
+
Binary file
kcl/py.typed ADDED
File without changes
@@ -0,0 +1,10 @@
1
+ Metadata-Version: 2.4
2
+ Name: zoo-kcl
3
+ Version: 0.3.120
4
+ Classifier: Programming Language :: Rust
5
+ Classifier: Programming Language :: Python :: Implementation :: CPython
6
+ Classifier: Programming Language :: Python :: Implementation :: PyPy
7
+ Requires-Dist: pytest ; extra == 'test'
8
+ Requires-Dist: pytest-asyncio ; extra == 'test'
9
+ Provides-Extra: test
10
+ Requires-Python: >=3.11
@@ -0,0 +1,7 @@
1
+ kcl\__init__.py,sha256=T7M_b9AF2d97a_BRNIooWXmH2jrRRz2ZNvof8LPV-D8,95
2
+ kcl\__init__.pyi,sha256=Zxj5sVWtmfysu18W9SIpY4L8WeLVmJoDTRqfjr4aIpA,19925
3
+ kcl\kcl.cp313-win_amd64.pyd,sha256=1hIVhHw4a7uZcz9c5YGUo8nAJ5-bc8e0Fz-xend-PgU,14373376
4
+ kcl\py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
5
+ zoo_kcl-0.3.120.dist-info\METADATA,sha256=EYhBBJIFs_w7v_Ca3V37rHO3tcPI-0N1DQxENTdKyLM,368
6
+ zoo_kcl-0.3.120.dist-info\WHEEL,sha256=n_BmF69IyGtioVWE9c3M_zsEfe6-xMZy1v5HCL_6qE0,97
7
+ zoo_kcl-0.3.120.dist-info\RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: maturin (1.8.3)
2
+ Generator: maturin (1.11.5)
3
3
  Root-Is-Purelib: false
4
4
  Tag: cp313-cp313-win_amd64
@@ -1,53 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: zoo-kcl
3
- Version: 0.3.60
4
- Classifier: Programming Language :: Rust
5
- Classifier: Programming Language :: Python :: Implementation :: CPython
6
- Classifier: Programming Language :: Python :: Implementation :: PyPy
7
- Requires-Dist: pytest ; extra == 'test'
8
- Requires-Dist: pytest-asyncio ; extra == 'test'
9
- Provides-Extra: test
10
- Requires-Python: >=3.8
11
- Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
12
- Project-URL: Source Code, https://github.com/kittycad/modeling-app
13
-
14
- # kcl-python-bindings
15
-
16
- Python bindings to the rust kcl-lib crate.
17
-
18
- ## Usage
19
-
20
- The [tests.py](tests/tests.py) file contains examples of how to use the library.
21
-
22
- ## Development
23
-
24
- We use [maturin](https://github.com/PyO3/maturin) for this project.
25
-
26
- You can either download binaries from the [latest release](https://github.com/PyO3/maturin/releases/latest) or install it with [pipx](https://pypa.github.io/pipx/):
27
-
28
- ```shell
29
- pipx install maturin
30
- ```
31
-
32
- > [!NOTE]
33
- >
34
- > `pip install maturin` should also work if you don't want to use pipx.
35
-
36
- There are four main commands:
37
-
38
- - `maturin publish` builds the crate into python packages and publishes them to pypi.
39
- - `maturin build` builds the wheels and stores them in a folder (`target/wheels` by default), but doesn't upload them. It's possible to upload those with [twine](https://github.com/pypa/twine) or `maturin upload`.
40
- - `maturin develop` builds the crate and installs it as a python module directly in the current virtualenv. Note that while `maturin develop` is faster, it doesn't support all the feature that running `pip install` after `maturin build` supports.
41
-
42
- `pyo3` bindings are automatically detected.
43
- `maturin` doesn't need extra configuration files and doesn't clash with an existing setuptools-rust or milksnake configuration.
44
-
45
- ### Releasing a new version
46
-
47
- 1. Make sure the `Cargo.toml` has the new version you want to release.
48
- 2. Run `make tag` this is just an easy command for making a tag formatted
49
- correctly with the version.
50
- 3. Push the tag (the result of `make tag` gives instructions for this)
51
- 4. Everything else is triggered from the tag push. Just make sure all the tests
52
- pass on the `main` branch before making and pushing a new tag.
53
-
@@ -1,5 +0,0 @@
1
- zoo_kcl-0.3.60.dist-info/METADATA,sha256=90JMooCYXi49GfhVkEVPBBTuyKfiZTjZQMA-BNTBXfE,2247
2
- zoo_kcl-0.3.60.dist-info/WHEEL,sha256=6gg8M7kMeWmDzkhJuJzWLhBYdt7OGDF81wlSJjN85_E,96
3
- kcl/__init__.py,sha256=T7M_b9AF2d97a_BRNIooWXmH2jrRRz2ZNvof8LPV-D8,95
4
- kcl/kcl.cp313-win_amd64.pyd,sha256=h1XVIEO_8dWlVP8qH4a9tA4SbmfxOrc5IT40X3x39-c,11595776
5
- zoo_kcl-0.3.60.dist-info/RECORD,,