-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
677 lines (615 loc) · 58.5 KB
/
index.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
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="History" href="history.html" />
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>mockfs documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=302659d7" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">mockfs documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
<span class="sidebar-brand-text">mockfs documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html"><code class="docutils literal notranslate"><span class="pre">os.path</span></code> and <code class="docutils literal notranslate"><span class="pre">glob</span></code> Implementations</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html#module-mockfs.util">Utility Functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html#module-mockfs.storage">File Storage and IO</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="_sources/index.rst.txt" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="mockfs-a-simple-mock-filesystem-for-unit-tests">
<h1><a class="reference internal" href="#module-mockfs" title="mockfs"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mockfs</span></code></a> – A simple mock filesystem for unit tests<a class="headerlink" href="#mockfs-a-simple-mock-filesystem-for-unit-tests" title="Link to this heading">¶</a></h1>
<p><cite>mockfs</cite> makes it possible to test filesystem-dependent code by
replacing functions from the <a class="reference external" href="https://docs.python.org/3/library/os.html#module-os" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/glob.html#module-glob" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code></a> modules.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a></li>
</ul>
</div>
<section id="example-unit-test">
<h2>Example Unit Test<a class="headerlink" href="#example-unit-test" title="Link to this heading">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">unittest</span>
<span class="kn">import</span> <span class="nn">mockfs</span>
<span class="k">def</span> <span class="nf">test_context_manager</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""The MockFS class can be used as context manager"""</span>
<span class="k">with</span> <span class="n">mockfs</span><span class="o">.</span><span class="n">MockFS</span><span class="p">(</span><span class="n">entries</span><span class="o">=</span><span class="p">{</span><span class="s1">'/tmp/does/not/exist'</span><span class="p">:</span> <span class="s1">'mockfs'</span><span class="p">})</span> <span class="k">as</span> <span class="n">mfs</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s1">'/tmp/does/not/exist'</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'/tmp/does/not/exist'</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">'utf-8'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">content</span> <span class="o">==</span> <span class="s1">'mockfs'</span>
<span class="n">mfs</span><span class="o">.</span><span class="n">add_entries</span><span class="p">({</span><span class="s1">'/tmp/does/not/exist-2'</span><span class="p">:</span> <span class="s1">'mockfs'</span><span class="p">})</span>
<span class="k">assert</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s1">'/tmp/does/not/exist-2'</span><span class="p">)</span>
<span class="c1"># Context manager scope ends: everything is back to normal now.</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s1">'/tmp/does/not/exist'</span><span class="p">)</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="s1">'/tmp/does/not/exist-2'</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ExampleTestCase</span><span class="p">(</span><span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""The mockfs module can be used in setUp() and tearDown()"""</span>
<span class="k">def</span> <span class="nf">setUp</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mfs</span> <span class="o">=</span> <span class="n">mockfs</span><span class="o">.</span><span class="n">replace_builtins</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mfs</span><span class="o">.</span><span class="n">add_entries</span><span class="p">({</span><span class="s1">'/usr/bin/mockfs-magic'</span><span class="p">:</span> <span class="s1">'magic'</span><span class="p">})</span>
<span class="k">def</span> <span class="nf">tearDown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">mockfs</span><span class="o">.</span><span class="n">restore_builtins</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">test_using_os_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="s1">'/usr/bin'</span><span class="p">),</span> <span class="p">[</span><span class="s1">'mockfs-magic'</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">test_using_open</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">'/usr/bin/mockfs-magic'</span><span class="p">)</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
<span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assertEqual</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="s1">'magic'</span><span class="p">)</span>
</pre></div>
</div>
<p>Currently supported functions:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#open" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/glob.html#glob.glob" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">glob.glob()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.chdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.chdir()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.getcwd" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.getcwd()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.listdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.listdir()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.makedirs" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.makedirs()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.abspath" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.abspath()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.exists" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.exists()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.getsize" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.getsize()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.islink" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.islink()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.isdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isdir()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.isfile" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isfile()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.remove" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.remove()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.rmdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.rmdir()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.unlink" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.unlink()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/os.html#os.walk" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.walk()</span></code></a></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/shutil.html#shutil.rmtree" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">shutil.rmtree()</span></code></a></p></li>
</ul>
</section>
<section id="developer-documentation">
<h2>Developer Documentation<a class="headerlink" href="#developer-documentation" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html"><code class="docutils literal notranslate"><span class="pre">os.path</span></code> and <code class="docutils literal notranslate"><span class="pre">glob</span></code> Implementations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.mfs.Cwd"><code class="docutils literal notranslate"><span class="pre">Cwd</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.Cwd.chdir"><code class="docutils literal notranslate"><span class="pre">Cwd.chdir()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.Cwd.getcwd"><code class="docutils literal notranslate"><span class="pre">Cwd.getcwd()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.Cwd.getcwdu"><code class="docutils literal notranslate"><span class="pre">Cwd.getcwdu()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.mfs.MockFS"><code class="docutils literal notranslate"><span class="pre">MockFS</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.abspath"><code class="docutils literal notranslate"><span class="pre">MockFS.abspath()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.add_entries"><code class="docutils literal notranslate"><span class="pre">MockFS.add_entries()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.copytree"><code class="docutils literal notranslate"><span class="pre">MockFS.copytree()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.exists"><code class="docutils literal notranslate"><span class="pre">MockFS.exists()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.getsize"><code class="docutils literal notranslate"><span class="pre">MockFS.getsize()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.glob"><code class="docutils literal notranslate"><span class="pre">MockFS.glob()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.isdir"><code class="docutils literal notranslate"><span class="pre">MockFS.isdir()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.isfile"><code class="docutils literal notranslate"><span class="pre">MockFS.isfile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.islink"><code class="docutils literal notranslate"><span class="pre">MockFS.islink()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.listdir"><code class="docutils literal notranslate"><span class="pre">MockFS.listdir()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.makedirs"><code class="docutils literal notranslate"><span class="pre">MockFS.makedirs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.read"><code class="docutils literal notranslate"><span class="pre">MockFS.read()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.remove"><code class="docutils literal notranslate"><span class="pre">MockFS.remove()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.rmdir"><code class="docutils literal notranslate"><span class="pre">MockFS.rmdir()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.rmtree"><code class="docutils literal notranslate"><span class="pre">MockFS.rmtree()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.MockFS.walk"><code class="docutils literal notranslate"><span class="pre">MockFS.walk()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.mfs.StorageBackend"><code class="docutils literal notranslate"><span class="pre">StorageBackend</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.StorageBackend.CheckForFile"><code class="docutils literal notranslate"><span class="pre">StorageBackend.CheckForFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.StorageBackend.DeleteFile"><code class="docutils literal notranslate"><span class="pre">StorageBackend.DeleteFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.StorageBackend.LoadFile"><code class="docutils literal notranslate"><span class="pre">StorageBackend.LoadFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.mfs.StorageBackend.SaveFile"><code class="docutils literal notranslate"><span class="pre">StorageBackend.SaveFile()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.mfs.replace_builtins"><code class="docutils literal notranslate"><span class="pre">replace_builtins()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.mfs.restore_builtins"><code class="docutils literal notranslate"><span class="pre">restore_builtins()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html#module-mockfs.util">Utility Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.build_nested_dict"><code class="docutils literal notranslate"><span class="pre">build_nested_dict()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.build_nested_dir_dict"><code class="docutils literal notranslate"><span class="pre">build_nested_dir_dict()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.is_dir"><code class="docutils literal notranslate"><span class="pre">is_dir()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.is_file"><code class="docutils literal notranslate"><span class="pre">is_file()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.is_string"><code class="docutils literal notranslate"><span class="pre">is_string()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.merge_dicts"><code class="docutils literal notranslate"><span class="pre">merge_dicts()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.util.sanitize"><code class="docutils literal notranslate"><span class="pre">sanitize()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html#module-mockfs.storage">File Storage and IO</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.backend"><code class="docutils literal notranslate"><span class="pre">backend</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.backend.CheckForFile"><code class="docutils literal notranslate"><span class="pre">backend.CheckForFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.backend.DeleteFile"><code class="docutils literal notranslate"><span class="pre">backend.DeleteFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.backend.LoadFile"><code class="docutils literal notranslate"><span class="pre">backend.LoadFile()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.backend.SaveFile"><code class="docutils literal notranslate"><span class="pre">backend.SaveFile()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.file"><code class="docutils literal notranslate"><span class="pre">file</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.close"><code class="docutils literal notranslate"><span class="pre">file.close()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.closed"><code class="docutils literal notranslate"><span class="pre">file.closed</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.encoding"><code class="docutils literal notranslate"><span class="pre">file.encoding</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.errors"><code class="docutils literal notranslate"><span class="pre">file.errors</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.fileno"><code class="docutils literal notranslate"><span class="pre">file.fileno()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.flush"><code class="docutils literal notranslate"><span class="pre">file.flush()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.isatty"><code class="docutils literal notranslate"><span class="pre">file.isatty()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.mode"><code class="docutils literal notranslate"><span class="pre">file.mode</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.name"><code class="docutils literal notranslate"><span class="pre">file.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.newlines"><code class="docutils literal notranslate"><span class="pre">file.newlines</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.next"><code class="docutils literal notranslate"><span class="pre">file.next()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.read"><code class="docutils literal notranslate"><span class="pre">file.read()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.readline"><code class="docutils literal notranslate"><span class="pre">file.readline()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.readlines"><code class="docutils literal notranslate"><span class="pre">file.readlines()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.seek"><code class="docutils literal notranslate"><span class="pre">file.seek()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.softspace"><code class="docutils literal notranslate"><span class="pre">file.softspace</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.tell"><code class="docutils literal notranslate"><span class="pre">file.tell()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.truncate"><code class="docutils literal notranslate"><span class="pre">file.truncate()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.write"><code class="docutils literal notranslate"><span class="pre">file.write()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.writelines"><code class="docutils literal notranslate"><span class="pre">file.writelines()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#mockfs.storage.file.xreadlines"><code class="docutils literal notranslate"><span class="pre">file.xreadlines()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.get_new_fileno"><code class="docutils literal notranslate"><span class="pre">get_new_fileno()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.open"><code class="docutils literal notranslate"><span class="pre">open()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.replace_builtins"><code class="docutils literal notranslate"><span class="pre">replace_builtins()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#mockfs.storage.restore_builtins"><code class="docutils literal notranslate"><span class="pre">restore_builtins()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="history.html">History</a><ul>
<li class="toctree-l2"><a class="reference internal" href="history.html#v2-0-0">v2.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-1-3">v1.1.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-1-2">v1.1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-1-1">v1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-1-0">v1.1.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-0-2">v1.0.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-0-1">v1.0.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v1-0-0">v1.0.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v0-9-0">v0.9.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v0-8-0">v0.8.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="history.html#v0-6-0">v0.6.0</a></li>
</ul>
</li>
</ul>
</div>
<dl class="py class" id="module-mockfs">
<dt class="sig sig-object py" id="mockfs.MockFS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mockfs.</span></span><span class="sig-name descname"><span class="pre">MockFS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS" title="Link to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>MockFS implementation object</p>
<p>Provides stubs for functions in <a class="reference external" href="https://docs.python.org/3/library/os.html#module-os" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/os.path.html#module-os.path" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">os.path</span></code></a>, and <a class="reference external" href="https://docs.python.org/3/library/glob.html#module-glob" title="(in Python v3.13)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code></a>.</p>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.abspath">
<span class="sig-name descname"><span class="pre">abspath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.abspath" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.add_entries">
<span class="sig-name descname"><span class="pre">add_entries</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.add_entries" title="Link to this definition">¶</a></dt>
<dd><p>Add new entries to mockfs.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.copytree">
<span class="sig-name descname"><span class="pre">copytree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dst</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.copytree" title="Link to this definition">¶</a></dt>
<dd><p>Copy a directory subtree</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/shutil.html#shutil.copytree" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">shutil.copytree()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.exists">
<span class="sig-name descname"><span class="pre">exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.exists" title="Link to this definition">¶</a></dt>
<dd><p>Return True if path exists</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.exists" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.exists()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.getsize">
<span class="sig-name descname"><span class="pre">getsize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.getsize" title="Link to this definition">¶</a></dt>
<dd><p>Return the size of a file, reported by os.stat().</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.glob">
<span class="sig-name descname"><span class="pre">glob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.glob" title="Link to this definition">¶</a></dt>
<dd><p>Implementation of <a class="reference external" href="https://docs.python.org/3/library/glob.html#glob.glob" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">glob.glob()</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.isdir">
<span class="sig-name descname"><span class="pre">isdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.isdir" title="Link to this definition">¶</a></dt>
<dd><p>Return True if path is a directory</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.isdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isdir()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.isfile">
<span class="sig-name descname"><span class="pre">isfile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.isfile" title="Link to this definition">¶</a></dt>
<dd><p>Return True if path is a file</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.path.html#os.path.isfile" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isfile()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.islink">
<span class="sig-name descname"><span class="pre">islink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.islink" title="Link to this definition">¶</a></dt>
<dd><p>Return True if path is a symlink</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Currently hard-wired to return False</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.listdir">
<span class="sig-name descname"><span class="pre">listdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.listdir" title="Link to this definition">¶</a></dt>
<dd><p>Return the directory contents of ‘path’</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.html#os.listdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.listdir()</span></code></a> interface.
:param path: filesystem path</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.makedirs">
<span class="sig-name descname"><span class="pre">makedirs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.makedirs" title="Link to this definition">¶</a></dt>
<dd><p>Create directory entries for a path</p>
<p>Raise OSError if the path already exists.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.read">
<span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.read" title="Link to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.remove">
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.remove" title="Link to this definition">¶</a></dt>
<dd><p>Remove the entry for a file path</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.html#os.remove" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.remove()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.rmdir">
<span class="sig-name descname"><span class="pre">rmdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fspath</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.rmdir" title="Link to this definition">¶</a></dt>
<dd><p>Remove the entry for a directory path</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.html#os.rmdir" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.rmdir()</span></code></a> interface.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.rmtree">
<span class="sig-name descname"><span class="pre">rmtree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">onerror</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.rmtree" title="Link to this definition">¶</a></dt>
<dd><p>Recursively delete a directory tree.</p>
<p>If ignore_errors is set, errors are ignored; otherwise, if onerror
is set, it is called to handle the error with arguments (func,
path, exc_info) where func is os.listdir, os.remove, or os.rmdir;
path is the argument to that function that caused it to fail; and
exc_info is a tuple returned by sys.exc_info(). If ignore_errors
is false and onerror is None, an exception is raised.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="mockfs.MockFS.walk">
<span class="sig-name descname"><span class="pre">walk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.MockFS.walk" title="Link to this definition">¶</a></dt>
<dd><p>Walk a filesystem path</p>
<p>Implements the <a class="reference external" href="https://docs.python.org/3/library/os.html#os.walk" title="(in Python v3.13)"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.walk()</span></code></a> interface.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mockfs.replace_builtins">
<span class="sig-prename descclassname"><span class="pre">mockfs.</span></span><span class="sig-name descname"><span class="pre">replace_builtins</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.replace_builtins" title="Link to this definition">¶</a></dt>
<dd><p>Replace builtin functions with mockfs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entries</strong> – Dictionary mapping paths to content</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Newly installed <a class="reference internal" href="api.html#mockfs.mfs.MockFS" title="mockfs.mfs.MockFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">mockfs.mfs.MockFS</span></code></a> instance.</p>
</dd>
</dl>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">os</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">mockfs</span>
<span class="gp">>>> </span><span class="n">fs</span> <span class="o">=</span> <span class="n">mockfs</span><span class="o">.</span><span class="n">replace_builtins</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">fs</span><span class="o">.</span><span class="n">add_entries</span><span class="p">({</span>
<span class="gp">... </span> <span class="s1">'/bin/sh'</span><span class="p">:</span> <span class="s1">'contents'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s1">'/bin/ls'</span><span class="p">:</span> <span class="s1">'contents'</span><span class="p">,</span>
<span class="gp">... </span><span class="p">})</span>
<span class="gp">>>> </span><span class="k">assert</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="s1">'/bin'</span><span class="p">)</span> <span class="o">==</span> <span class="p">[</span><span class="s1">'ls'</span><span class="p">,</span> <span class="s1">'sh'</span><span class="p">])</span>
<span class="gp">>>> </span><span class="n">mockfs</span><span class="o">.</span><span class="n">restore_builtins</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="mockfs.restore_builtins">
<span class="sig-prename descclassname"><span class="pre">mockfs.</span></span><span class="sig-name descname"><span class="pre">restore_builtins</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mockfs.restore_builtins" title="Link to this definition">¶</a></dt>
<dd><p>Restore the original builtin functions.</p>
</dd></dl>
</section>
<section id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="history.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">History</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright ©
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mockfs</span></code> – A simple mock filesystem for unit tests</a><ul>
<li><a class="reference internal" href="#example-unit-test">Example Unit Test</a></li>
<li><a class="reference internal" href="#developer-documentation">Developer Documentation</a><ul>
<li><a class="reference internal" href="#mockfs.MockFS"><code class="docutils literal notranslate"><span class="pre">MockFS</span></code></a><ul>
<li><a class="reference internal" href="#mockfs.MockFS.abspath"><code class="docutils literal notranslate"><span class="pre">MockFS.abspath()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.add_entries"><code class="docutils literal notranslate"><span class="pre">MockFS.add_entries()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.copytree"><code class="docutils literal notranslate"><span class="pre">MockFS.copytree()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.exists"><code class="docutils literal notranslate"><span class="pre">MockFS.exists()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.getsize"><code class="docutils literal notranslate"><span class="pre">MockFS.getsize()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.glob"><code class="docutils literal notranslate"><span class="pre">MockFS.glob()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.isdir"><code class="docutils literal notranslate"><span class="pre">MockFS.isdir()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.isfile"><code class="docutils literal notranslate"><span class="pre">MockFS.isfile()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.islink"><code class="docutils literal notranslate"><span class="pre">MockFS.islink()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.listdir"><code class="docutils literal notranslate"><span class="pre">MockFS.listdir()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.makedirs"><code class="docutils literal notranslate"><span class="pre">MockFS.makedirs()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.read"><code class="docutils literal notranslate"><span class="pre">MockFS.read()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.remove"><code class="docutils literal notranslate"><span class="pre">MockFS.remove()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.rmdir"><code class="docutils literal notranslate"><span class="pre">MockFS.rmdir()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.rmtree"><code class="docutils literal notranslate"><span class="pre">MockFS.rmtree()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.MockFS.walk"><code class="docutils literal notranslate"><span class="pre">MockFS.walk()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#mockfs.replace_builtins"><code class="docutils literal notranslate"><span class="pre">replace_builtins()</span></code></a></li>
<li><a class="reference internal" href="#mockfs.restore_builtins"><code class="docutils literal notranslate"><span class="pre">restore_builtins()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
</body>
</html>