{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Raises": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Yields": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Methods": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Returns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Progress-bar helpers."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Receives": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warnings": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Attributes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Two shapes for two consumers:"
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "progress_class(dummy=...)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " returns a Progress "
                    },
                    {
                      "__type": "Emphasis",
                      "__tag": 4047,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "class"
                        }
                      ]
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " (rich's, or a   no-op "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "DummyProgress"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "). Use when you want to drive   "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "add_task"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " / "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "advance"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " / "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "update"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " yourself, e.g.        "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "with progress_class(dummy=cfg.dummy_progress)(...) as p:\n    task = p.add_task(\"...\", total=N)\n    ...",
                  "execution_status": null
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "iter_with_progress(iterable, dummy=...)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " is a generator that yields   "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "(progress, item)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " pairs. Use when the loop body just needs the   current progress to update its own description."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Other Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    }
  },
  "_ordered_sections": [
    "Summary",
    "Extended Summary",
    "Parameters",
    "Attributes",
    "Methods",
    "Returns",
    "Yields",
    "Receives",
    "Other Parameters",
    "Raises",
    "Warns",
    "Warnings",
    "Notes"
  ],
  "item_file": "/papyri/_progress.py",
  "item_line": 0,
  "item_type": "module",
  "aliases": [
    "papyri._progress"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": null,
  "references": null,
  "qa": "papyri._progress",
  "arbitrary": [
    {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Progress-bar helpers."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Two shapes for two consumers:"
            }
          ]
        },
        {
          "__type": "BulletList",
          "__tag": 4053,
          "ordered": false,
          "start": 1,
          "children": [
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "progress_class(dummy=...)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " returns a Progress "
                    },
                    {
                      "__type": "Emphasis",
                      "__tag": 4047,
                      "children": [
                        {
                          "__type": "Text",
                          "__tag": 4046,
                          "value": "class"
                        }
                      ]
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " (rich's, or a   no-op "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "DummyProgress"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "). Use when you want to drive   "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "add_task"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " / "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "advance"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " / "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "update"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " yourself, e.g.        "
                    }
                  ]
                },
                {
                  "__type": "Code",
                  "__tag": 4050,
                  "value": "with progress_class(dummy=cfg.dummy_progress)(...) as p:\n    task = p.add_task(\"...\", total=N)\n    ...",
                  "execution_status": null
                }
              ]
            },
            {
              "__type": "ListItem",
              "__tag": 4054,
              "children": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "iter_with_progress(iterable, dummy=...)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " is a generator that yields   "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "(progress, item)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " pairs. Use when the loop body just needs the   current progress to update its own description."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    }
  ],
  "local_refs": []
}