-
Notifications
You must be signed in to change notification settings - Fork 14
/
_plugins.html
913 lines (735 loc) · 65.8 KB
/
_plugins.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>mitre.securingai.pyplugs._plugins — Dioptra 0.0.0 documentation</title>
<link href="../../../../_static/css/theme.css" rel="stylesheet" />
<link href="../../../../_static/css/index.c5995385ac14fb8791e8eb36b4908be2.css" rel="stylesheet" />
<link rel="stylesheet"
href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/sphinx-book-theme.css?digest=c3fdc42140077d1ad13ad2f1588a4309" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/togglebutton.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/securing-ai-testbed.css" />
<link rel="preload" as="script" href="../../../../_static/js/index.1c5a1a01449ed65a7b51.js">
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/togglebutton.js"></script>
<script >var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script src="../../../../_static/sphinx-book-theme.12a9622fbb08dcb3a2a40b2c02b83a57.js"></script>
<script src="../../../../_static/jquery.visible.js"></script>
<script src="../../../../_static/jquery.leaveNotice-nist.js"></script>
<script src="../../../../_static/applyLeaveNotice.js"></script>
<script src="../../../../_static/smoothNavScroll.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
<link rel="stylesheet" href="https://pages.nist.gov/nist-header-footer/css/nist-combined.css">
<link rel="stylesheet" type="text/css" href="https://pages.nist.gov/leaveNotice/css/jquery.leaveNotice.css" />
<script src="https://pages.nist.gov/nist-header-footer/js/nist-header-footer.js" type="text/javascript" defer="defer"></script>
<script async type="text/javascript" id="_fed_an_ua_tag" src="https://dap.digitalgov.gov/Universal-Federated-Analytics-Min.js?agency=NIST&subagency=github&pua=UA-66610693-1&yt=true&exts=ppsx,pps,f90,sch,rtf,wrl,txz,m1v,xlsm,msi,xsd,f,tif,eps,mpg,xml,pl,xlt,c"></script>
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar site-navigation show" id="site-navigation">
<div class="navbar-brand-box">
<a class="navbar-brand text-wrap" href="../../../../index.html">
<h1 class="site-logo" id="site-title">Dioptra 0.0.0 documentation</h1>
</a>
</div><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../index.html">
What is Dioptra?
</a>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../glossary.html">
Glossary
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Getting Started
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../getting-started/installation.html">
Installation Guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../getting-started/newcomer-tips.html">
Setup Tips for Newcomers
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
User Guide
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/the-basics.html">
The Basics
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/entry-points.html">
Entry Points
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/task-plugins.html">
Task Plugins
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/custom-entry-points.html">
Creating a New Entry Point
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/custom-task-plugins.html">
Custom Task Plugins
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/generics-plugin-system.html">
Generics Plugin System
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../../../user-guide/task-plugins-collection.html">
Task Plugins Collection
</a>
<input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
<label for="toctree-checkbox-1">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-artifacts.html">
artifacts
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-attacks.html">
attacks
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-backend_configs.html">
backend_configs
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-data.html">
data
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-estimators.html">
estimators
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-metrics.html">
metrics
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-random.html">
random
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-registry.html">
registry
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-task-plugins/api-builtins-tracking.html">
tracking
</a>
</li>
</ul>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../../../user-guide/api-reference-sdk.html">
Testbed SDK API Reference
</a>
<input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
<label for="toctree-checkbox-2">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-generics.html">
generics
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-utilities.html">
utilities
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-exceptions.html">
exceptions
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-pyplugs.html">
pyplugs
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-rq.html">
rq
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../user-guide/api-sdk/api-cryptography.html">
cryptography
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../user-guide/api-reference-restapi.html">
Testbed REST API Reference
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Tutorials and Examples
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-basic-mlflow-demo.html">
Hello World!
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-mnist-classifier.html">
First Steps - MNIST Tensorflow Classifier
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-mnist-feature-squeezing.html">
Tensorflow MNIST Feature Squeezing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-mnist-model-inversion.html">
Tensorflow MNIST Model Inversion
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-adversarial-patches.html">
Tensorflow Adversarial Patch
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-backdoor-poisoning.html">
Tensorflow Backdoor Poisoning
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-imagenet-resnet50-fgm.html">
Tensorflow ImageNet Resnet50 FGM
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-tensorflow-imagenet-pixel-threshold.html">
Tensorflow ImageNet Pixel Threshold
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../tutorials/example-pytorch-mnist-membership-inference.html">
PyTorch MNIST Membership Inference
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Deployment Guide
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/system-requirements.html">
System Requirements
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/docker-images-list-and-settings.html">
Docker Images List and Settings
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/single-machine-deployment.html">
Single Machine Deployment
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/task-plugins-management.html">
Task Plugins Management
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/obtaining-datasets.html">
How to Obtain Common Datasets
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../deployment-guide/testbed-ansible-collection.html">
Testbed Ansible Collection
</a>
</li>
</ul>
<p class="caption">
<span class="caption-text">
Developer Guides
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children">
<a class="reference internal" href="../../../../dev-guide/index.html">
Getting Involved / Contributing
</a>
<input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
<label for="toctree-checkbox-3">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="../../../../dev-guide/contributing-merge-request-guidelines.html">
Merge Request Guidelines
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../dev-guide/contributing-commit-styleguide.html">
Commit Styleguide
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="../../../../dev-guide/contributing-build-dev-images.html">
Building Development Docker Images
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../dev-guide/programming-style.html">
Programming Style Guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../dev-guide/design-architecture.html">
Testbed Architecture Design Guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../dev-guide/design-restapi.html">
Testbed REST API Design Guide
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="../../../../dev-guide/design-sdk.html">
Testbed SDK Design Guide
</a>
</li>
</ul>
</div>
</nav>
<!-- To handle the deprecated key -->
<div class="navbar_extra_footer">
<div>
<a href="../../../../developers.html"><em>Development Team</em></a>
</div>
</div>
</div>
<main class="col py-md-3 pl-md-4 bd-content overflow-auto" role="main">
<div class="topbar container-xl fixed-top">
<div class="topbar-contents row">
<div class="col-12 col-md-3 bd-topbar-whitespace site-navigation show"></div>
<div class="col pl-md-4 topbar-main">
<button id="navbar-toggler" class="navbar-toggler ml-0" type="button" data-toggle="collapse"
data-toggle="tooltip" data-placement="bottom" data-target=".site-navigation" aria-controls="navbar-menu"
aria-expanded="true" aria-label="Toggle navigation" aria-controls="site-navigation"
title="Toggle navigation" data-toggle="tooltip" data-placement="left">
<i class="fas fa-bars"></i>
<i class="fas fa-arrow-left"></i>
<i class="fas fa-arrow-up"></i>
</button>
<!-- Source interaction buttons -->
<div class="dropdown-buttons-trigger">
<button id="dropdown-buttons-trigger" class="btn btn-secondary topbarbtn"
aria-label="Connect with source repository"><i class="fab fa-github"></i></button>
<div class="dropdown-buttons sourcebuttons">
<a class="repository-button"
href="https://github.com/usnistgov/dioptra"><button type="button" class="btn btn-secondary topbarbtn"
data-toggle="tooltip" data-placement="left" title="Source repository"><i
class="fab fa-github"></i>repository</button></a>
</div>
</div>
<!-- Full screen (wrap in <a> to have style consistency -->
<a class="full-screen-button"><button type="button" class="btn btn-secondary topbarbtn" data-toggle="tooltip"
data-placement="bottom" onclick="toggleFullScreen()" aria-label="Fullscreen mode"
title="Fullscreen mode"><i
class="fas fa-expand"></i></button></a>
<!-- Launch buttons -->
</div>
<!-- Table of contents -->
<div class="d-none d-md-block col-md-2 bd-toc show">
</div>
</div>
</div>
<div id="main-content" class="row">
<div class="col-12 col-md-9 pl-md-3 pr-md-0">
<div>
<h1>Source code for mitre.securingai.pyplugs._plugins</h1><div class="highlight"><pre>
<span></span><span class="c1"># This Software (Dioptra) is being made available as a public service by the</span>
<span class="c1"># National Institute of Standards and Technology (NIST), an Agency of the United</span>
<span class="c1"># States Department of Commerce. This software was developed in part by employees of</span>
<span class="c1"># NIST and in part by NIST contractors. Copyright in portions of this software that</span>
<span class="c1"># were developed by NIST contractors has been licensed or assigned to NIST. Pursuant</span>
<span class="c1"># to Title 17 United States Code Section 105, works of NIST employees are not</span>
<span class="c1"># subject to copyright protection in the United States. However, NIST may hold</span>
<span class="c1"># international copyright in software created by its employees and domestic</span>
<span class="c1"># copyright (or licensing rights) in portions of software that were assigned or</span>
<span class="c1"># licensed to NIST. To the extent that NIST holds copyright in this software, it is</span>
<span class="c1"># being made available under the Creative Commons Attribution 4.0 International</span>
<span class="c1"># license (CC BY 4.0). The disclaimers of the CC BY 4.0 license apply to all parts</span>
<span class="c1"># of the software developed or licensed by NIST.</span>
<span class="c1">#</span>
<span class="c1"># ACCESS THE FULL CC BY 4.0 LICENSE HERE:</span>
<span class="c1"># https://creativecommons.org/licenses/by/4.0/legalcode</span>
<span class="c1">#</span>
<span class="c1"># This is a fork of the work</span>
<span class="c1"># https://github.com/gahjelle/pyplugs/blob/90e635777672f75080291c737f08453a26ea380d/pyplugs/_plugins.py # noqa: B950</span>
<span class="c1"># See copyright below.</span>
<span class="c1">#</span>
<span class="c1"># Copyright (c) 2019 Geir Arne Hjelle</span>
<span class="c1"># Distributed under the terms of the MIT License.</span>
<span class="c1">#</span>
<span class="c1"># Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<span class="c1"># of this software and associated documentation files (the "Software"), to deal</span>
<span class="c1"># in the Software without restriction, including without limitation the rights</span>
<span class="c1"># to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<span class="c1"># copies of the Software, and to permit persons to whom the Software is</span>
<span class="c1"># furnished to do so, subject to the following conditions:</span>
<span class="c1">#</span>
<span class="c1"># The above copyright notice and this permission notice shall be included in all</span>
<span class="c1"># copies or substantial portions of the Software.</span>
<span class="c1">#</span>
<span class="c1"># THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<span class="c1"># IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<span class="c1"># FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<span class="c1"># AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<span class="c1"># LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<span class="c1"># OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span>
<span class="c1"># SOFTWARE.</span>
<span class="sd">"""Decorators for registering plugins"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
<span class="kn">import</span> <span class="nn">functools</span>
<span class="kn">import</span> <span class="nn">importlib</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">textwrap</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">TYPE_CHECKING</span><span class="p">,</span>
<span class="n">Any</span><span class="p">,</span>
<span class="n">Callable</span><span class="p">,</span>
<span class="n">Dict</span><span class="p">,</span>
<span class="n">List</span><span class="p">,</span>
<span class="n">NamedTuple</span><span class="p">,</span>
<span class="n">Optional</span><span class="p">,</span>
<span class="n">TypeVar</span><span class="p">,</span>
<span class="n">Union</span><span class="p">,</span>
<span class="n">overload</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">import</span> <span class="nn">structlog</span>
<span class="kn">from</span> <span class="nn">structlog.stdlib</span> <span class="kn">import</span> <span class="n">BoundLogger</span>
<span class="kn">from</span> <span class="nn">mitre.securingai.sdk.exceptions</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">PrefectDependencyError</span><span class="p">,</span>
<span class="n">UnknownPackageError</span><span class="p">,</span>
<span class="n">UnknownPluginError</span><span class="p">,</span>
<span class="n">UnknownPluginFunctionError</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">mitre.securingai.sdk.utilities.decorators</span> <span class="kn">import</span> <span class="n">require_package</span>
<span class="n">LOGGER</span><span class="p">:</span> <span class="n">BoundLogger</span> <span class="o">=</span> <span class="n">structlog</span><span class="o">.</span><span class="n">stdlib</span><span class="o">.</span><span class="n">get_logger</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">importlib</span> <span class="kn">import</span> <span class="n">resources</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: nocover</span>
<span class="kn">import</span> <span class="nn">importlib_resources</span> <span class="k">as</span> <span class="nn">resources</span> <span class="c1"># type: ignore</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">prefect</span> <span class="kn">import</span> <span class="n">task</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: nocover</span>
<span class="n">LOGGER</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">"Unable to import one or more optional packages, functionality may be reduced"</span><span class="p">,</span>
<span class="n">package</span><span class="o">=</span><span class="s2">"prefect"</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Protocol</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: nocover</span>
<span class="kn">from</span> <span class="nn">typing_extensions</span> <span class="kn">import</span> <span class="n">Protocol</span> <span class="c1"># type: ignore</span>
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">prefect.core.task</span> <span class="kn">import</span> <span class="n">TaskMetaclass</span> <span class="k">as</span> <span class="n">Task</span>
<span class="c1"># Structural subtyping</span>
<span class="k">class</span> <span class="nc">NoutPlugin</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
<span class="n">_task_nout</span><span class="p">:</span> <span class="nb">int</span>
<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
<span class="o">...</span> <span class="c1"># pragma: nocover</span>
<span class="c1"># Type aliases</span>
<span class="n">F</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">"F"</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="n">NoutPlugin</span><span class="p">)</span>
<span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">"T"</span><span class="p">)</span>
<span class="n">Plugin</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
<span class="c1"># Only expose decorated functions to the outside</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">expose</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">]:</span>
<span class="sd">"""Add function to __all__ so it will be exposed at the top level"""</span>
<span class="n">__all__</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">class</span> <span class="nc">PluginInfo</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
<span class="sd">"""Information about one plug-in"""</span>
<span class="n">package_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">plugin_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">func_name</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">func</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Plugin</span><span class="p">,</span> <span class="n">NoutPlugin</span><span class="p">]</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">doc</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">module_doc</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">sort_value</span><span class="p">:</span> <span class="nb">float</span>
<span class="c1"># Dictionary with information about all registered plug-ins</span>
<span class="n">_PLUGINS</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">PluginInfo</span><span class="p">]]]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">sort_value</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Plugin</span><span class="p">],</span> <span class="n">Plugin</span><span class="p">]:</span>
<span class="sd">"""Signature for using decorator with parameters"""</span>
<span class="o">...</span> <span class="c1"># pragma: nocover</span>
<span class="nd">@overload</span>
<span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">Plugin</span><span class="p">)</span> <span class="o">-></span> <span class="n">Plugin</span><span class="p">:</span>
<span class="sd">"""Signature for using decorator without parameters"""</span>
<span class="o">...</span> <span class="c1"># pragma: nocover</span>
<div class="viewcode-block" id="register"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.register">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">register</span><span class="p">(</span>
<span class="n">_func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Plugin</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">sort_value</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span>
<span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="sd">"""Decorator for registering a new plug-in"""</span>
<span class="k">def</span> <span class="nf">decorator_register</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">]:</span>
<span class="sd">"""Store information about the given function"""</span>
<span class="n">package_name</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">plugin_name</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__module__</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span>
<span class="n">description</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">doc</span> <span class="o">=</span> <span class="p">(</span><span class="n">func</span><span class="o">.</span><span class="vm">__doc__</span> <span class="ow">or</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">partition</span><span class="p">(</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span><span class="p">)</span>
<span class="n">func_name</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
<span class="n">module_doc</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">func</span><span class="o">.</span><span class="vm">__module__</span><span class="p">]</span><span class="o">.</span><span class="vm">__doc__</span> <span class="ow">or</span> <span class="s2">""</span>
<span class="n">pkg_info</span> <span class="o">=</span> <span class="n">_PLUGINS</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">package_name</span><span class="p">,</span> <span class="p">{})</span>
<span class="n">plugin_info</span> <span class="o">=</span> <span class="n">pkg_info</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">plugin_name</span><span class="p">,</span> <span class="p">{})</span>
<span class="n">plugin_info</span><span class="p">[</span><span class="n">func_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">PluginInfo</span><span class="p">(</span>
<span class="n">package_name</span><span class="o">=</span><span class="n">package_name</span><span class="p">,</span>
<span class="n">plugin_name</span><span class="o">=</span><span class="n">plugin_name</span><span class="p">,</span>
<span class="n">func_name</span><span class="o">=</span><span class="n">func_name</span><span class="p">,</span>
<span class="n">func</span><span class="o">=</span><span class="n">func</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">doc</span><span class="o">=</span><span class="n">textwrap</span><span class="o">.</span><span class="n">dedent</span><span class="p">(</span><span class="n">doc</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span>
<span class="n">module_doc</span><span class="o">=</span><span class="n">module_doc</span><span class="p">,</span>
<span class="n">sort_value</span><span class="o">=</span><span class="n">sort_value</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">if</span> <span class="n">_func</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">decorator_register</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">decorator_register</span><span class="p">(</span><span class="n">_func</span><span class="p">)</span></div>
<div class="viewcode-block" id="task_nout"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.task_nout">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">task_nout</span><span class="p">(</span><span class="n">nout</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="n">F</span><span class="p">],</span> <span class="n">F</span><span class="p">]:</span>
<span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">F</span><span class="p">)</span> <span class="o">-></span> <span class="n">F</span><span class="p">:</span>
<span class="n">func</span><span class="o">.</span><span class="n">_task_nout</span> <span class="o">=</span> <span class="n">nout</span>
<span class="k">return</span> <span class="n">func</span>
<span class="k">return</span> <span class="n">decorator</span></div>
<div class="viewcode-block" id="names"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.names">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">names</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">"""List all plug-ins in one package"""</span>
<span class="n">_import_all</span><span class="p">(</span><span class="n">package</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">(),</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">p</span><span class="p">:</span> <span class="n">info</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">p</span><span class="p">)</span><span class="o">.</span><span class="n">sort_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="funcs"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.funcs">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">funcs</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="sd">"""List all functions in one plug-in"""</span>
<span class="n">_import</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">)</span>
<span class="n">plugin_info</span> <span class="o">=</span> <span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">][</span><span class="n">plugin</span><span class="p">]</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">plugin_info</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>
<div class="viewcode-block" id="info"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.info">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">PluginInfo</span><span class="p">:</span>
<span class="sd">"""Get information about a plug-in"""</span>
<span class="n">_import</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">plugin_info</span> <span class="o">=</span> <span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">][</span><span class="n">plugin</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">UnknownPluginError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">"Could not find any plug-in named </span><span class="si">{</span><span class="n">plugin</span><span class="si">!r}</span><span class="s2"> inside </span><span class="si">{</span><span class="n">package</span><span class="si">!r}</span><span class="s2">. "</span>
<span class="s2">"Use pyplugs.register to register functions as plug-ins"</span>
<span class="p">)</span> <span class="kn">from</span> <span class="nn">exc</span>
<span class="n">func</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">plugin_info</span><span class="o">.</span><span class="n">keys</span><span class="p">()))</span> <span class="k">if</span> <span class="n">func</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">func</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">plugin_info</span><span class="p">[</span><span class="n">func</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">UnknownPluginFunctionError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">"Could not find any function named </span><span class="si">{</span><span class="n">func</span><span class="si">!r}</span><span class="s2"> inside '</span><span class="si">{</span><span class="n">package</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">plugin</span><span class="si">}</span><span class="s2">'. "</span>
<span class="s2">"Use pyplugs.register to register plug-in functions"</span>
<span class="p">)</span> <span class="kn">from</span> <span class="nn">exc</span></div>
<div class="viewcode-block" id="exists"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.exists">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
<span class="sd">"""Check if a given plugin exists"""</span>
<span class="k">if</span> <span class="n">package</span> <span class="ow">in</span> <span class="n">_PLUGINS</span> <span class="ow">and</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_import</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">)</span>
<span class="k">except</span> <span class="p">(</span><span class="n">UnknownPluginError</span><span class="p">,</span> <span class="n">UnknownPackageError</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">package</span> <span class="ow">in</span> <span class="n">_PLUGINS</span> <span class="ow">and</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">]</span></div>
<div class="viewcode-block" id="get"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.get">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">Plugin</span><span class="p">:</span>
<span class="sd">"""Get a given plugin"""</span>
<span class="k">return</span> <span class="n">info</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">func</span><span class="p">)</span><span class="o">.</span><span class="n">func</span></div>
<div class="viewcode-block" id="call"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.call">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">call</span><span class="p">(</span>
<span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span>
<span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
<span class="sd">"""Call the given plugin"""</span>
<span class="n">plugin_func</span> <span class="o">=</span> <span class="n">get</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">func</span><span class="p">)</span>
<span class="k">return</span> <span class="n">plugin_func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_task"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.get_task">[docs]</a><span class="nd">@expose</span>
<span class="nd">@require_package</span><span class="p">(</span><span class="s2">"prefect"</span><span class="p">,</span> <span class="n">exc_type</span><span class="o">=</span><span class="n">PrefectDependencyError</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_task</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="n">Task</span><span class="p">:</span>
<span class="sd">"""Get a given plugin wrapped as a prefect task"""</span>
<span class="n">plugin_func</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Plugin</span><span class="p">,</span> <span class="n">NoutPlugin</span><span class="p">]</span> <span class="o">=</span> <span class="n">info</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">func</span><span class="p">)</span><span class="o">.</span><span class="n">func</span>
<span class="n">nout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">plugin_func</span><span class="p">,</span> <span class="s2">"_task_nout"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">return</span> <span class="n">task</span><span class="p">(</span><span class="n">plugin_func</span><span class="p">,</span> <span class="n">nout</span><span class="o">=</span><span class="n">nout</span><span class="p">)</span> <span class="c1"># type: ignore</span></div>
<div class="viewcode-block" id="call_task"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.call_task">[docs]</a><span class="nd">@expose</span>
<span class="nd">@require_package</span><span class="p">(</span><span class="s2">"prefect"</span><span class="p">,</span> <span class="n">exc_type</span><span class="o">=</span><span class="n">PrefectDependencyError</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">call_task</span><span class="p">(</span>
<span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span>
<span class="p">)</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
<span class="sd">"""Call the given plugin as a prefect task"""</span>
<span class="n">plugin_task</span> <span class="o">=</span> <span class="n">get_task</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">,</span> <span class="n">func</span><span class="p">)</span>
<span class="k">return</span> <span class="n">plugin_task</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_import</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">plugin</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="sd">"""Import the given plugin file from a package"""</span>
<span class="k">if</span> <span class="n">package</span> <span class="ow">in</span> <span class="n">_PLUGINS</span> <span class="ow">and</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">_PLUGINS</span><span class="p">[</span><span class="n">package</span><span class="p">]:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="n">plugin_module</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">package</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">plugin</span><span class="si">}</span><span class="s2">"</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">importlib</span><span class="o">.</span><span class="n">import_module</span><span class="p">(</span><span class="n">plugin_module</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">repr</span><span class="p">(</span><span class="n">plugin_module</span><span class="p">)</span> <span class="ow">in</span> <span class="n">err</span><span class="o">.</span><span class="n">msg</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">UnknownPluginError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">"Plugin </span><span class="si">{</span><span class="n">plugin</span><span class="si">!r}</span><span class="s2"> not found in </span><span class="si">{</span><span class="n">package</span><span class="si">!r}</span><span class="s2">"</span>
<span class="p">)</span> <span class="kn">from</span> <span class="bp">None</span>
<span class="k">elif</span> <span class="nb">repr</span><span class="p">(</span><span class="n">package</span><span class="p">)</span> <span class="ow">in</span> <span class="n">err</span><span class="o">.</span><span class="n">msg</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">UnknownPackageError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Package </span><span class="si">{</span><span class="n">package</span><span class="si">!r}</span><span class="s2"> does not exist"</span><span class="p">)</span> <span class="kn">from</span> <span class="bp">None</span>
<span class="k">raise</span>
<span class="k">def</span> <span class="nf">_import_all</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
<span class="sd">"""Import all plugins in a package"""</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">all_resources</span> <span class="o">=</span> <span class="n">resources</span><span class="o">.</span><span class="n">contents</span><span class="p">(</span><span class="n">package</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">UnknownPackageError</span><span class="p">(</span><span class="n">err</span><span class="p">)</span> <span class="kn">from</span> <span class="bp">None</span>
<span class="c1"># Note that we have tried to import the package by adding it to _PLUGINS</span>
<span class="n">_PLUGINS</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="p">{})</span>
<span class="c1"># Loop through all Python files in the directories of the package</span>
<span class="n">plugins</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">r</span><span class="p">[:</span><span class="o">-</span><span class="mi">3</span><span class="p">]</span> <span class="k">for</span> <span class="n">r</span> <span class="ow">in</span> <span class="n">all_resources</span> <span class="k">if</span> <span class="n">r</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".py"</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">r</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"_"</span><span class="p">)</span>
<span class="p">]</span>
<span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">plugins</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_import</span><span class="p">(</span><span class="n">package</span><span class="p">,</span> <span class="n">plugin</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span> <span class="c1"># Don't let errors in one plugin, affect the others</span>
<div class="viewcode-block" id="names_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.names_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">names_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[],</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span>
<span class="sd">"""Create a names() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="funcs_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.funcs_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">funcs_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">],</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]:</span>
<span class="sd">"""Create a funcs() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">funcs</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="info_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.info_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">info_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]],</span> <span class="n">PluginInfo</span><span class="p">]:</span>
<span class="sd">"""Create a info() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">info</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="exists_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.exists_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">exists_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">bool</span><span class="p">]:</span>
<span class="sd">"""Create an exists() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">exists</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.get_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">get_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]],</span> <span class="n">Plugin</span><span class="p">]:</span>
<span class="sd">"""Create a get() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">get</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="call_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.call_factory">[docs]</a><span class="nd">@expose</span>
<span class="k">def</span> <span class="nf">call_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="sd">"""Create a call() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">call</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_task_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.get_task_factory">[docs]</a><span class="nd">@expose</span>
<span class="nd">@require_package</span><span class="p">(</span><span class="s2">"prefect"</span><span class="p">,</span> <span class="n">exc_type</span><span class="o">=</span><span class="n">PrefectDependencyError</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_task_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]],</span> <span class="n">Task</span><span class="p">]:</span>
<span class="sd">"""Create a get_task() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">get_task</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
<div class="viewcode-block" id="call_task_factory"><a class="viewcode-back" href="../../../../user-guide/api-sdk/api-pyplugs.html#mitre.securingai.pyplugs.call_task_factory">[docs]</a><span class="nd">@expose</span>
<span class="nd">@require_package</span><span class="p">(</span><span class="s2">"prefect"</span><span class="p">,</span> <span class="n">exc_type</span><span class="o">=</span><span class="n">PrefectDependencyError</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">call_task_factory</span><span class="p">(</span><span class="n">package</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="sd">"""Create a call_task() function for one package"""</span>
<span class="k">return</span> <span class="n">functools</span><span class="o">.</span><span class="n">partial</span><span class="p">(</span><span class="n">call_task</span><span class="p">,</span> <span class="n">package</span><span class="p">)</span></div>
</pre></div>
</div>
<div class='prev-next-bottom'>
</div>
</div>
</div>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
<div class="disclaimer">
<strong>Disclaimer:</strong> Certain commercial equipment, instruments, or
materials are identified in this documentation to foster understanding. Such
identification does not imply recommendation or endorsement by the National
Institute of Standards and Technology, nor does it imply that the materials
or equipment identified are necessarily the best available for the purpose.
</div>
</p>
</div>
</footer>
</main>
</div>
</div>
<script src="../../../../_static/js/index.1c5a1a01449ed65a7b51.js"></script>
</body>
</html>