Repository navigation
Expand file tree
/
Copy pathdoctest.po
More file actions
2086 lines (1772 loc) · 73 KB
/
Copy pathdoctest.po
File metadata and controls
2086 lines (1772 loc) · 73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2001-2022, Python Software Foundation
# This file is distributed under the same license as the Python package.
#
# Translators:
msgid ""
msgstr ""
"Project-Id-Version: Python 3.12\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-07-17 17:39+0800\n"
"PO-Revision-Date: 2018-05-23 14:43+0000\n"
"Last-Translator: Adrian Liaw <adrianliaw2000@gmail.com>\n"
"Language-Team: Chinese - TAIWAN (https://github.com/python/python-docs-zh-"
"tw)\n"
"Language: zh_TW\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=1; plural=0;\n"
#: ../../library/doctest.rst:2
msgid ":mod:`doctest` --- Test interactive Python examples"
msgstr ""
#: ../../library/doctest.rst:12
msgid "**Source code:** :source:`Lib/doctest.py`"
msgstr "**原始碼：**\\ :source:`Lib/doctest.py`"
#: ../../library/doctest.rst:16
msgid ""
"The :mod:`doctest` module searches for pieces of text that look like "
"interactive Python sessions, and then executes those sessions to verify that "
"they work exactly as shown. There are several common ways to use doctest:"
msgstr ""
#: ../../library/doctest.rst:20
msgid ""
"To check that a module's docstrings are up-to-date by verifying that all "
"interactive examples still work as documented."
msgstr ""
#: ../../library/doctest.rst:23
msgid ""
"To perform regression testing by verifying that interactive examples from a "
"test file or a test object work as expected."
msgstr ""
#: ../../library/doctest.rst:26
msgid ""
"To write tutorial documentation for a package, liberally illustrated with "
"input-output examples. Depending on whether the examples or the expository "
"text are emphasized, this has the flavor of \"literate testing\" or "
"\"executable documentation\"."
msgstr ""
#: ../../library/doctest.rst:31
msgid "Here's a complete but small example module::"
msgstr ""
#: ../../library/doctest.rst:88
msgid ""
"If you run :file:`example.py` directly from the command line, :mod:`doctest` "
"works its magic:"
msgstr ""
#: ../../library/doctest.rst:96
msgid ""
"There's no output! That's normal, and it means all the examples worked. "
"Pass ``-v`` to the script, and :mod:`doctest` prints a detailed log of what "
"it's trying, and prints a summary at the end:"
msgstr ""
#: ../../library/doctest.rst:114
msgid "And so on, eventually ending with:"
msgstr ""
#: ../../library/doctest.rst:133
msgid ""
"That's all you need to know to start making productive use of :mod:"
"`doctest`! Jump in. The following sections provide full details. Note that "
"there are many examples of doctests in the standard Python test suite and "
"libraries. Especially useful examples can be found in the standard test "
"file :file:`Lib/test/test_doctest.py`."
msgstr ""
#: ../../library/doctest.rst:143
msgid "Simple Usage: Checking Examples in Docstrings"
msgstr ""
#: ../../library/doctest.rst:145
msgid ""
"The simplest way to start using doctest (but not necessarily the way you'll "
"continue to do it) is to end each module :mod:`M` with::"
msgstr ""
#: ../../library/doctest.rst:152
msgid ":mod:`doctest` then examines docstrings in module :mod:`M`."
msgstr ""
#: ../../library/doctest.rst:154
msgid ""
"Running the module as a script causes the examples in the docstrings to get "
"executed and verified::"
msgstr ""
#: ../../library/doctest.rst:159
msgid ""
"This won't display anything unless an example fails, in which case the "
"failing example(s) and the cause(s) of the failure(s) are printed to stdout, "
"and the final line of output is ``***Test Failed*** N failures.``, where *N* "
"is the number of examples that failed."
msgstr ""
#: ../../library/doctest.rst:164
msgid "Run it with the ``-v`` switch instead::"
msgstr ""
#: ../../library/doctest.rst:168
msgid ""
"and a detailed report of all examples tried is printed to standard output, "
"along with assorted summaries at the end."
msgstr ""
#: ../../library/doctest.rst:171
msgid ""
"You can force verbose mode by passing ``verbose=True`` to :func:`testmod`, "
"or prohibit it by passing ``verbose=False``. In either of those cases, "
"``sys.argv`` is not examined by :func:`testmod` (so passing ``-v`` or not "
"has no effect)."
msgstr ""
#: ../../library/doctest.rst:176
msgid ""
"There is also a command line shortcut for running :func:`testmod`. You can "
"instruct the Python interpreter to run the doctest module directly from the "
"standard library and pass the module name(s) on the command line::"
msgstr ""
#: ../../library/doctest.rst:182
msgid ""
"This will import :file:`example.py` as a standalone module and run :func:"
"`testmod` on it. Note that this may not work correctly if the file is part "
"of a package and imports other submodules from that package."
msgstr ""
#: ../../library/doctest.rst:186
msgid ""
"For more information on :func:`testmod`, see section :ref:`doctest-basic-"
"api`."
msgstr ""
#: ../../library/doctest.rst:192
msgid "Simple Usage: Checking Examples in a Text File"
msgstr ""
#: ../../library/doctest.rst:194
msgid ""
"Another simple application of doctest is testing interactive examples in a "
"text file. This can be done with the :func:`testfile` function::"
msgstr ""
#: ../../library/doctest.rst:200
msgid ""
"That short script executes and verifies any interactive Python examples "
"contained in the file :file:`example.txt`. The file content is treated as "
"if it were a single giant docstring; the file doesn't need to contain a "
"Python program! For example, perhaps :file:`example.txt` contains this:"
msgstr ""
#: ../../library/doctest.rst:223
msgid ""
"Running ``doctest.testfile(\"example.txt\")`` then finds the error in this "
"documentation::"
msgstr ""
#: ../../library/doctest.rst:234
msgid ""
"As with :func:`testmod`, :func:`testfile` won't display anything unless an "
"example fails. If an example does fail, then the failing example(s) and the "
"cause(s) of the failure(s) are printed to stdout, using the same format as :"
"func:`testmod`."
msgstr ""
#: ../../library/doctest.rst:239
msgid ""
"By default, :func:`testfile` looks for files in the calling module's "
"directory. See section :ref:`doctest-basic-api` for a description of the "
"optional arguments that can be used to tell it to look for files in other "
"locations."
msgstr ""
#: ../../library/doctest.rst:243
msgid ""
"Like :func:`testmod`, :func:`testfile`'s verbosity can be set with the ``-"
"v`` command-line switch or with the optional keyword argument *verbose*."
msgstr ""
#: ../../library/doctest.rst:247
msgid ""
"There is also a command line shortcut for running :func:`testfile`. You can "
"instruct the Python interpreter to run the doctest module directly from the "
"standard library and pass the file name(s) on the command line::"
msgstr ""
#: ../../library/doctest.rst:253
msgid ""
"Because the file name does not end with :file:`.py`, :mod:`doctest` infers "
"that it must be run with :func:`testfile`, not :func:`testmod`."
msgstr ""
#: ../../library/doctest.rst:256
msgid ""
"For more information on :func:`testfile`, see section :ref:`doctest-basic-"
"api`."
msgstr ""
#: ../../library/doctest.rst:262
msgid "How It Works"
msgstr ""
#: ../../library/doctest.rst:264
msgid ""
"This section examines in detail how doctest works: which docstrings it looks "
"at, how it finds interactive examples, what execution context it uses, how "
"it handles exceptions, and how option flags can be used to control its "
"behavior. This is the information that you need to know to write doctest "
"examples; for information about actually running doctest on these examples, "
"see the following sections."
msgstr ""
#: ../../library/doctest.rst:275
msgid "Which Docstrings Are Examined?"
msgstr ""
#: ../../library/doctest.rst:277
msgid ""
"The module docstring, and all function, class and method docstrings are "
"searched. Objects imported into the module are not searched."
msgstr ""
#: ../../library/doctest.rst:280
msgid ""
"In addition, if ``M.__test__`` exists and \"is true\", it must be a dict, "
"and each entry maps a (string) name to a function object, class object, or "
"string. Function and class object docstrings found from ``M.__test__`` are "
"searched, and strings are treated as if they were docstrings. In output, a "
"key ``K`` in ``M.__test__`` appears with name ::"
msgstr ""
#: ../../library/doctest.rst:288
msgid ""
"Any classes found are recursively searched similarly, to test docstrings in "
"their contained methods and nested classes."
msgstr ""
#: ../../library/doctest.rst:295
msgid "How are Docstring Examples Recognized?"
msgstr ""
#: ../../library/doctest.rst:297
msgid ""
"In most cases a copy-and-paste of an interactive console session works fine, "
"but doctest isn't trying to do an exact emulation of any specific Python "
"shell."
msgstr ""
#: ../../library/doctest.rst:322
msgid ""
"Any expected output must immediately follow the final ``'>>> '`` or ``'... "
"'`` line containing the code, and the expected output (if any) extends to "
"the next ``'>>> '`` or all-whitespace line."
msgstr ""
#: ../../library/doctest.rst:326
msgid "The fine print:"
msgstr ""
#: ../../library/doctest.rst:328
msgid ""
"Expected output cannot contain an all-whitespace line, since such a line is "
"taken to signal the end of expected output. If expected output does contain "
"a blank line, put ``<BLANKLINE>`` in your doctest example each place a blank "
"line is expected."
msgstr ""
#: ../../library/doctest.rst:333
msgid ""
"All hard tab characters are expanded to spaces, using 8-column tab stops. "
"Tabs in output generated by the tested code are not modified. Because any "
"hard tabs in the sample output *are* expanded, this means that if the code "
"output includes hard tabs, the only way the doctest can pass is if the :"
"const:`NORMALIZE_WHITESPACE` option or :ref:`directive <doctest-directives>` "
"is in effect. Alternatively, the test can be rewritten to capture the output "
"and compare it to an expected value as part of the test. This handling of "
"tabs in the source was arrived at through trial and error, and has proven to "
"be the least error prone way of handling them. It is possible to use a "
"different algorithm for handling tabs by writing a custom :class:"
"`DocTestParser` class."
msgstr ""
#: ../../library/doctest.rst:345
msgid ""
"Output to stdout is captured, but not output to stderr (exception tracebacks "
"are captured via a different means)."
msgstr ""
#: ../../library/doctest.rst:348
msgid ""
"If you continue a line via backslashing in an interactive session, or for "
"any other reason use a backslash, you should use a raw docstring, which will "
"preserve your backslashes exactly as you type them::"
msgstr ""
#: ../../library/doctest.rst:358
msgid ""
"Otherwise, the backslash will be interpreted as part of the string. For "
"example, the ``\\n`` above would be interpreted as a newline character. "
"Alternatively, you can double each backslash in the doctest version (and not "
"use a raw string)::"
msgstr ""
#: ../../library/doctest.rst:368
msgid "The starting column doesn't matter::"
msgstr ""
#: ../../library/doctest.rst:375
msgid ""
"and as many leading whitespace characters are stripped from the expected "
"output as appeared in the initial ``'>>> '`` line that started the example."
msgstr ""
#: ../../library/doctest.rst:382
msgid "What's the Execution Context?"
msgstr ""
#: ../../library/doctest.rst:384
msgid ""
"By default, each time :mod:`doctest` finds a docstring to test, it uses a "
"*shallow copy* of :mod:`M`'s globals, so that running tests doesn't change "
"the module's real globals, and so that one test in :mod:`M` can't leave "
"behind crumbs that accidentally allow another test to work. This means "
"examples can freely use any names defined at top-level in :mod:`M`, and "
"names defined earlier in the docstring being run. Examples cannot see names "
"defined in other docstrings."
msgstr ""
#: ../../library/doctest.rst:392
msgid ""
"You can force use of your own dict as the execution context by passing "
"``globs=your_dict`` to :func:`testmod` or :func:`testfile` instead."
msgstr ""
#: ../../library/doctest.rst:399
msgid "What About Exceptions?"
msgstr ""
#: ../../library/doctest.rst:401
msgid ""
"No problem, provided that the traceback is the only output produced by the "
"example: just paste in the traceback. [#]_ Since tracebacks contain details "
"that are likely to change rapidly (for example, exact file paths and line "
"numbers), this is one case where doctest works hard to be flexible in what "
"it accepts."
msgstr ""
#: ../../library/doctest.rst:407
msgid "Simple example::"
msgstr ""
"簡單範例：\n"
"\n"
"::"
#: ../../library/doctest.rst:414
msgid ""
"That doctest succeeds if :exc:`ValueError` is raised, with the ``list."
"remove(x): x not in list`` detail as shown."
msgstr ""
#: ../../library/doctest.rst:417
msgid ""
"The expected output for an exception must start with a traceback header, "
"which may be either of the following two lines, indented the same as the "
"first line of the example::"
msgstr ""
#: ../../library/doctest.rst:424
msgid ""
"The traceback header is followed by an optional traceback stack, whose "
"contents are ignored by doctest. The traceback stack is typically omitted, "
"or copied verbatim from an interactive session."
msgstr ""
#: ../../library/doctest.rst:428
msgid ""
"The traceback stack is followed by the most interesting part: the line(s) "
"containing the exception type and detail. This is usually the last line of "
"a traceback, but can extend across multiple lines if the exception has a "
"multi-line detail::"
msgstr ""
#: ../../library/doctest.rst:440
msgid ""
"The last three lines (starting with :exc:`ValueError`) are compared against "
"the exception's type and detail, and the rest are ignored."
msgstr ""
#: ../../library/doctest.rst:443
msgid ""
"Best practice is to omit the traceback stack, unless it adds significant "
"documentation value to the example. So the last example is probably better "
"as::"
msgstr ""
#: ../../library/doctest.rst:453
msgid ""
"Note that tracebacks are treated very specially. In particular, in the "
"rewritten example, the use of ``...`` is independent of doctest's :const:"
"`ELLIPSIS` option. The ellipsis in that example could be left out, or could "
"just as well be three (or three hundred) commas or digits, or an indented "
"transcript of a Monty Python skit."
msgstr ""
#: ../../library/doctest.rst:459
msgid "Some details you should read once, but won't need to remember:"
msgstr ""
#: ../../library/doctest.rst:461
msgid ""
"Doctest can't guess whether your expected output came from an exception "
"traceback or from ordinary printing. So, e.g., an example that expects "
"``ValueError: 42 is prime`` will pass whether :exc:`ValueError` is actually "
"raised or if the example merely prints that traceback text. In practice, "
"ordinary output rarely begins with a traceback header line, so this doesn't "
"create real problems."
msgstr ""
#: ../../library/doctest.rst:468
msgid ""
"Each line of the traceback stack (if present) must be indented further than "
"the first line of the example, *or* start with a non-alphanumeric character. "
"The first line following the traceback header indented the same and starting "
"with an alphanumeric is taken to be the start of the exception detail. Of "
"course this does the right thing for genuine tracebacks."
msgstr ""
#: ../../library/doctest.rst:474
msgid ""
"When the :const:`IGNORE_EXCEPTION_DETAIL` doctest option is specified, "
"everything following the leftmost colon and any module information in the "
"exception name is ignored."
msgstr ""
#: ../../library/doctest.rst:478
msgid ""
"The interactive shell omits the traceback header line for some :exc:"
"`SyntaxError`\\ s. But doctest uses the traceback header line to "
"distinguish exceptions from non-exceptions. So in the rare case where you "
"need to test a :exc:`SyntaxError` that omits the traceback header, you will "
"need to manually add the traceback header line to your test example."
msgstr ""
#: ../../library/doctest.rst:486
msgid ""
"For some exceptions, Python displays the position of the error using ``^`` "
"markers and tildes::"
msgstr ""
#: ../../library/doctest.rst:495
msgid ""
"Since the lines showing the position of the error come before the exception "
"type and detail, they are not checked by doctest. For example, the "
"following test would pass, even though it puts the ``^`` marker in the wrong "
"location::"
msgstr ""
#: ../../library/doctest.rst:510
msgid "Option Flags"
msgstr ""
#: ../../library/doctest.rst:512
msgid ""
"A number of option flags control various aspects of doctest's behavior. "
"Symbolic names for the flags are supplied as module constants, which can be :"
"ref:`bitwise ORed <bitwise>` together and passed to various functions. The "
"names can also be used in :ref:`doctest directives <doctest-directives>`, "
"and may be passed to the doctest command line interface via the ``-o`` "
"option."
msgstr ""
#: ../../library/doctest.rst:518
msgid "The ``-o`` command line option."
msgstr ""
#: ../../library/doctest.rst:521
msgid ""
"The first group of options define test semantics, controlling aspects of how "
"doctest decides whether actual output matches an example's expected output:"
msgstr ""
#: ../../library/doctest.rst:527
msgid ""
"By default, if an expected output block contains just ``1``, an actual "
"output block containing just ``1`` or just ``True`` is considered to be a "
"match, and similarly for ``0`` versus ``False``. When :const:"
"`DONT_ACCEPT_TRUE_FOR_1` is specified, neither substitution is allowed. The "
"default behavior caters to that Python changed the return type of many "
"functions from integer to boolean; doctests expecting \"little integer\" "
"output still work in these cases. This option will probably go away, but "
"not for several years."
msgstr ""
#: ../../library/doctest.rst:539
msgid ""
"By default, if an expected output block contains a line containing only the "
"string ``<BLANKLINE>``, then that line will match a blank line in the actual "
"output. Because a genuinely blank line delimits the expected output, this "
"is the only way to communicate that a blank line is expected. When :const:"
"`DONT_ACCEPT_BLANKLINE` is specified, this substitution is not allowed."
msgstr ""
#: ../../library/doctest.rst:548
msgid ""
"When specified, all sequences of whitespace (blanks and newlines) are "
"treated as equal. Any sequence of whitespace within the expected output "
"will match any sequence of whitespace within the actual output. By default, "
"whitespace must match exactly. :const:`NORMALIZE_WHITESPACE` is especially "
"useful when a line of expected output is very long, and you want to wrap it "
"across multiple lines in your source."
msgstr ""
#: ../../library/doctest.rst:559
msgid ""
"When specified, an ellipsis marker (``...``) in the expected output can "
"match any substring in the actual output. This includes substrings that "
"span line boundaries, and empty substrings, so it's best to keep usage of "
"this simple. Complicated uses can lead to the same kinds of \"oops, it "
"matched too much!\" surprises that ``.*`` is prone to in regular expressions."
msgstr ""
#: ../../library/doctest.rst:568
msgid ""
"When specified, doctests expecting exceptions pass so long as an exception "
"of the expected type is raised, even if the details (message and fully "
"qualified exception name) don't match."
msgstr ""
#: ../../library/doctest.rst:572
msgid ""
"For example, an example expecting ``ValueError: 42`` will pass if the actual "
"exception raised is ``ValueError: 3*14``, but will fail if, say, a :exc:"
"`TypeError` is raised instead. It will also ignore any fully qualified name "
"included before the exception class, which can vary between implementations "
"and versions of Python and the code/libraries in use. Hence, all three of "
"these variations will work with the flag specified:"
msgstr ""
#: ../../library/doctest.rst:594
msgid ""
"Note that :const:`ELLIPSIS` can also be used to ignore the details of the "
"exception message, but such a test may still fail based on whether the "
"module name is present or matches exactly."
msgstr ""
#: ../../library/doctest.rst:598
msgid ""
":const:`IGNORE_EXCEPTION_DETAIL` now also ignores any information relating "
"to the module containing the exception under test."
msgstr ""
#: ../../library/doctest.rst:605
msgid ""
"When specified, do not run the example at all. This can be useful in "
"contexts where doctest examples serve as both documentation and test cases, "
"and an example should be included for documentation purposes, but should not "
"be checked. E.g., the example's output might be random; or the example "
"might depend on resources which would be unavailable to the test driver."
msgstr ""
#: ../../library/doctest.rst:611
msgid ""
"The SKIP flag can also be used for temporarily \"commenting out\" examples."
msgstr ""
#: ../../library/doctest.rst:616
msgid "A bitmask or'ing together all the comparison flags above."
msgstr ""
#: ../../library/doctest.rst:618
msgid "The second group of options controls how test failures are reported:"
msgstr ""
#: ../../library/doctest.rst:623
msgid ""
"When specified, failures that involve multi-line expected and actual outputs "
"are displayed using a unified diff."
msgstr ""
#: ../../library/doctest.rst:629
msgid ""
"When specified, failures that involve multi-line expected and actual outputs "
"will be displayed using a context diff."
msgstr ""
#: ../../library/doctest.rst:635
msgid ""
"When specified, differences are computed by ``difflib.Differ``, using the "
"same algorithm as the popular :file:`ndiff.py` utility. This is the only "
"method that marks differences within lines as well as across lines. For "
"example, if a line of expected output contains digit ``1`` where actual "
"output contains letter ``l``, a line is inserted with a caret marking the "
"mismatching column positions."
msgstr ""
#: ../../library/doctest.rst:644
msgid ""
"When specified, display the first failing example in each doctest, but "
"suppress output for all remaining examples. This will prevent doctest from "
"reporting correct examples that break because of earlier failures; but it "
"might also hide incorrect examples that fail independently of the first "
"failure. When :const:`REPORT_ONLY_FIRST_FAILURE` is specified, the "
"remaining examples are still run, and still count towards the total number "
"of failures reported; only the output is suppressed."
msgstr ""
#: ../../library/doctest.rst:655
msgid ""
"When specified, exit after the first failing example and don't attempt to "
"run the remaining examples. Thus, the number of failures reported will be at "
"most 1. This flag may be useful during debugging, since examples after the "
"first failure won't even produce debugging output."
msgstr ""
#: ../../library/doctest.rst:660
msgid ""
"The doctest command line accepts the option ``-f`` as a shorthand for ``-o "
"FAIL_FAST``."
msgstr ""
#: ../../library/doctest.rst:668
msgid "A bitmask or'ing together all the reporting flags above."
msgstr ""
#: ../../library/doctest.rst:671
msgid ""
"There is also a way to register new option flag names, though this isn't "
"useful unless you intend to extend :mod:`doctest` internals via subclassing:"
msgstr ""
#: ../../library/doctest.rst:677
msgid ""
"Create a new option flag with a given name, and return the new flag's "
"integer value. :func:`register_optionflag` can be used when subclassing :"
"class:`OutputChecker` or :class:`DocTestRunner` to create new options that "
"are supported by your subclasses. :func:`register_optionflag` should always "
"be called using the following idiom::"
msgstr ""
#: ../../library/doctest.rst:693
msgid "Directives"
msgstr ""
#: ../../library/doctest.rst:695
msgid ""
"Doctest directives may be used to modify the :ref:`option flags <doctest-"
"options>` for an individual example. Doctest directives are special Python "
"comments following an example's source code:"
msgstr ""
#: ../../library/doctest.rst:706
msgid ""
"Whitespace is not allowed between the ``+`` or ``-`` and the directive "
"option name. The directive option name can be any of the option flag names "
"explained above."
msgstr ""
#: ../../library/doctest.rst:710
msgid ""
"An example's doctest directives modify doctest's behavior for that single "
"example. Use ``+`` to enable the named behavior, or ``-`` to disable it."
msgstr ""
#: ../../library/doctest.rst:713
msgid "For example, this test passes:"
msgstr ""
#: ../../library/doctest.rst:722
msgid ""
"Without the directive it would fail, both because the actual output doesn't "
"have two blanks before the single-digit list elements, and because the "
"actual output is on a single line. This test also passes, and also requires "
"a directive to do so:"
msgstr ""
#: ../../library/doctest.rst:733
msgid ""
"Multiple directives can be used on a single physical line, separated by "
"commas:"
msgstr ""
#: ../../library/doctest.rst:742
msgid ""
"If multiple directive comments are used for a single example, then they are "
"combined:"
msgstr ""
#: ../../library/doctest.rst:752
msgid ""
"As the previous example shows, you can add ``...`` lines to your example "
"containing only directives. This can be useful when an example is too long "
"for a directive to comfortably fit on the same line:"
msgstr ""
#: ../../library/doctest.rst:763
msgid ""
"Note that since all options are disabled by default, and directives apply "
"only to the example they appear in, enabling options (via ``+`` in a "
"directive) is usually the only meaningful choice. However, option flags can "
"also be passed to functions that run doctests, establishing different "
"defaults. In such cases, disabling an option via ``-`` in a directive can "
"be useful."
msgstr ""
#: ../../library/doctest.rst:773
msgid "Warnings"
msgstr ""
#: ../../library/doctest.rst:775
msgid ""
":mod:`doctest` is serious about requiring exact matches in expected output. "
"If even a single character doesn't match, the test fails. This will "
"probably surprise you a few times, as you learn exactly what Python does and "
"doesn't guarantee about output. For example, when printing a set, Python "
"doesn't guarantee that the element is printed in any particular order, so a "
"test like ::"
msgstr ""
#: ../../library/doctest.rst:784
msgid "is vulnerable! One workaround is to do ::"
msgstr ""
#: ../../library/doctest.rst:789
msgid "instead. Another is to do ::"
msgstr ""
#: ../../library/doctest.rst:795
msgid "There are others, but you get the idea."
msgstr ""
#: ../../library/doctest.rst:797
msgid "Another bad idea is to print things that embed an object address, like"
msgstr ""
#: ../../library/doctest.rst:807
msgid ""
"The :const:`ELLIPSIS` directive gives a nice approach for the last example:"
msgstr ""
#: ../../library/doctest.rst:815
msgid ""
"Floating-point numbers are also subject to small output variations across "
"platforms, because Python defers to the platform C library for float "
"formatting, and C libraries vary widely in quality here. ::"
msgstr ""
#: ../../library/doctest.rst:826
msgid ""
"Numbers of the form ``I/2.**J`` are safe across all platforms, and I often "
"contrive doctest examples to produce numbers of that form::"
msgstr ""
#: ../../library/doctest.rst:832
msgid ""
"Simple fractions are also easier for people to understand, and that makes "
"for better documentation."
msgstr ""
#: ../../library/doctest.rst:839
msgid "Basic API"
msgstr ""
#: ../../library/doctest.rst:841
msgid ""
"The functions :func:`testmod` and :func:`testfile` provide a simple "
"interface to doctest that should be sufficient for most basic uses. For a "
"less formal introduction to these two functions, see sections :ref:`doctest-"
"simple-testmod` and :ref:`doctest-simple-testfile`."
msgstr ""
#: ../../library/doctest.rst:849
msgid ""
"All arguments except *filename* are optional, and should be specified in "
"keyword form."
msgstr ""
#: ../../library/doctest.rst:852
msgid ""
"Test examples in the file named *filename*. Return ``(failure_count, "
"test_count)``."
msgstr ""
#: ../../library/doctest.rst:855
msgid ""
"Optional argument *module_relative* specifies how the filename should be "
"interpreted:"
msgstr ""
#: ../../library/doctest.rst:858
msgid ""
"If *module_relative* is ``True`` (the default), then *filename* specifies an "
"OS-independent module-relative path. By default, this path is relative to "
"the calling module's directory; but if the *package* argument is specified, "
"then it is relative to that package. To ensure OS-independence, *filename* "
"should use ``/`` characters to separate path segments, and may not be an "
"absolute path (i.e., it may not begin with ``/``)."
msgstr ""
#: ../../library/doctest.rst:865
msgid ""
"If *module_relative* is ``False``, then *filename* specifies an OS-specific "
"path. The path may be absolute or relative; relative paths are resolved "
"with respect to the current working directory."
msgstr ""
#: ../../library/doctest.rst:869
msgid ""
"Optional argument *name* gives the name of the test; by default, or if "
"``None``, ``os.path.basename(filename)`` is used."
msgstr ""
#: ../../library/doctest.rst:872
msgid ""
"Optional argument *package* is a Python package or the name of a Python "
"package whose directory should be used as the base directory for a module-"
"relative filename. If no package is specified, then the calling module's "
"directory is used as the base directory for module-relative filenames. It "
"is an error to specify *package* if *module_relative* is ``False``."
msgstr ""
#: ../../library/doctest.rst:878
msgid ""
"Optional argument *globs* gives a dict to be used as the globals when "
"executing examples. A new shallow copy of this dict is created for the "
"doctest, so its examples start with a clean slate. By default, or if "
"``None``, a new empty dict is used."
msgstr ""
#: ../../library/doctest.rst:883
msgid ""
"Optional argument *extraglobs* gives a dict merged into the globals used to "
"execute examples. This works like :meth:`dict.update`: if *globs* and "
"*extraglobs* have a common key, the associated value in *extraglobs* appears "
"in the combined dict. By default, or if ``None``, no extra globals are "
"used. This is an advanced feature that allows parameterization of "
"doctests. For example, a doctest can be written for a base class, using a "
"generic name for the class, then reused to test any number of subclasses by "
"passing an *extraglobs* dict mapping the generic name to the subclass to be "
"tested."
msgstr ""
#: ../../library/doctest.rst:892
msgid ""
"Optional argument *verbose* prints lots of stuff if true, and prints only "
"failures if false; by default, or if ``None``, it's true if and only if ``'-"
"v'`` is in ``sys.argv``."
msgstr ""
#: ../../library/doctest.rst:896
msgid ""
"Optional argument *report* prints a summary at the end when true, else "
"prints nothing at the end. In verbose mode, the summary is detailed, else "
"the summary is very brief (in fact, empty if all tests passed)."
msgstr ""
#: ../../library/doctest.rst:900
msgid ""
"Optional argument *optionflags* (default value 0) takes the :ref:`bitwise OR "
"<bitwise>` of option flags. See section :ref:`doctest-options`."
msgstr ""
#: ../../library/doctest.rst:904
msgid ""
"Optional argument *raise_on_error* defaults to false. If true, an exception "
"is raised upon the first failure or unexpected exception in an example. "
"This allows failures to be post-mortem debugged. Default behavior is to "
"continue running examples."
msgstr ""
#: ../../library/doctest.rst:909 ../../library/doctest.rst:1049
msgid ""
"Optional argument *parser* specifies a :class:`DocTestParser` (or subclass) "
"that should be used to extract tests from the files. It defaults to a "
"normal parser (i.e., ``DocTestParser()``)."
msgstr ""
#: ../../library/doctest.rst:913 ../../library/doctest.rst:1053
msgid ""
"Optional argument *encoding* specifies an encoding that should be used to "
"convert the file to unicode."
msgstr ""
#: ../../library/doctest.rst:919
msgid ""
"All arguments are optional, and all except for *m* should be specified in "
"keyword form."
msgstr ""
#: ../../library/doctest.rst:922
msgid ""
"Test examples in docstrings in functions and classes reachable from module "
"*m* (or module :mod:`__main__` if *m* is not supplied or is ``None``), "
"starting with ``m.__doc__``."
msgstr ""
#: ../../library/doctest.rst:926
msgid ""
"Also test examples reachable from dict ``m.__test__``, if it exists and is "
"not ``None``. ``m.__test__`` maps names (strings) to functions, classes and "
"strings; function and class docstrings are searched for examples; strings "
"are searched directly, as if they were docstrings."
msgstr ""
#: ../../library/doctest.rst:931
msgid ""
"Only docstrings attached to objects belonging to module *m* are searched."
msgstr ""
#: ../../library/doctest.rst:933
msgid "Return ``(failure_count, test_count)``."
msgstr ""
#: ../../library/doctest.rst:935
msgid ""
"Optional argument *name* gives the name of the module; by default, or if "
"``None``, ``m.__name__`` is used."
msgstr ""
#: ../../library/doctest.rst:938
msgid ""
"Optional argument *exclude_empty* defaults to false. If true, objects for "
"which no doctests are found are excluded from consideration. The default is "
"a backward compatibility hack, so that code still using :meth:`doctest."
"master.summarize` in conjunction with :func:`testmod` continues to get "
"output for objects with no tests. The *exclude_empty* argument to the newer :"
"class:`DocTestFinder` constructor defaults to true."
msgstr ""
#: ../../library/doctest.rst:945
msgid ""
"Optional arguments *extraglobs*, *verbose*, *report*, *optionflags*, "
"*raise_on_error*, and *globs* are the same as for function :func:`testfile` "
"above, except that *globs* defaults to ``m.__dict__``."
msgstr ""
#: ../../library/doctest.rst:952
msgid ""
"Test examples associated with object *f*; for example, *f* may be a string, "
"a module, a function, or a class object."
msgstr ""
#: ../../library/doctest.rst:955
msgid ""
"A shallow copy of dictionary argument *globs* is used for the execution "
"context."
msgstr ""
#: ../../library/doctest.rst:957
msgid ""
"Optional argument *name* is used in failure messages, and defaults to "
"``\"NoName\"``."
msgstr ""
#: ../../library/doctest.rst:960
msgid ""
"If optional argument *verbose* is true, output is generated even if there "
"are no failures. By default, output is generated only in case of an example "
"failure."
msgstr ""
#: ../../library/doctest.rst:963
msgid ""
"Optional argument *compileflags* gives the set of flags that should be used "
"by the Python compiler when running the examples. By default, or if "
"``None``, flags are deduced corresponding to the set of future features "
"found in *globs*."
msgstr ""
#: ../../library/doctest.rst:967
msgid ""
"Optional argument *optionflags* works as for function :func:`testfile` above."
msgstr ""
#: ../../library/doctest.rst:973
msgid "Unittest API"
msgstr ""
#: ../../library/doctest.rst:975
msgid ""
"As your collection of doctest'ed modules grows, you'll want a way to run all "
"their doctests systematically. :mod:`doctest` provides two functions that "
"can be used to create :mod:`unittest` test suites from modules and text "