{
  "__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": "A check that tests that a given value is an integer (int, or long) and optionally, between bounds. A negative value is accepted, while a float will fail."
            }
          ]
        }
      ],
      "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": "If the value is a string, then the conversion is done - if possible. Otherwise a VdtError is raised."
            }
          ]
        },
        {
          "__type": "Code",
          "__tag": 4050,
          "value": ">>> vtor.check('integer', '-1')\n-1\n>>> vtor.check('integer', '0')\n0\n>>> vtor.check('integer', 9)\n9\n>>> vtor.check('integer', 'a')\nTraceback (most recent call last):\nVdtTypeError: the value \"a\" is of the wrong type.\n>>> vtor.check('integer', '2.2')\nTraceback (most recent call last):\nVdtTypeError: the value \"2.2\" is of the wrong type.\n>>> vtor.check('integer(10)', '20')\n20\n>>> vtor.check('integer(max=20)', '15')\n15\n>>> vtor.check('integer(10)', '9')\nTraceback (most recent call last):\nVdtValueTooSmallError: the value \"9\" is too small.\n>>> vtor.check('integer(10)', 9)\nTraceback (most recent call last):\nVdtValueTooSmallError: the value \"9\" is too small.\n>>> vtor.check('integer(max=20)', '35')\nTraceback (most recent call last):\nVdtValueTooBigError: the value \"35\" is too big.\n>>> vtor.check('integer(max=20)', 35)\nTraceback (most recent call last):\nVdtValueTooBigError: the value \"35\" is too big.\n>>> vtor.check('integer(0, 9)', False)\n0",
          "execution_status": null,
          "out": ""
        }
      ],
      "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": "/astropy/extern/configobj/validate.py",
  "item_line": 783,
  "item_type": "function",
  "aliases": [
    "astropy.config.configuration.validate.is_integer"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "value",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "min",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "max",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": "None"
      }
    ],
    "return_annotation": {
      "__type": "Empty",
      "__tag": 4031
    },
    "target_name": "is_integer"
  },
  "references": null,
  "qa": "astropy.extern.configobj.validate:is_integer",
  "arbitrary": [],
  "local_refs": []
}