{
  "title": "log",
  "public_path": "flex_rf.tidy3d.log",
  "lookup_path": "tidy3d.log",
  "slug": "flex_rf/tidy3d/log",
  "public_url": "/rf/latest/autogenerated/flex_rf/tidy3d/log/",
  "object_kind": "module",
  "introduction": "Logging Configuration for Tidy3d.",
  "notes": "",
  "examples": "",
  "references": "",
  "signature": "log",
  "source": {
    "path": "flex/public/tidy3d/tidy3d/log.py",
    "url": "",
    "lineno": null,
    "endlineno": null
  },
  "bases": [],
  "parameter_rows": [],
  "members": [
    {
      "name": "CONSOLE_WIDTH",
      "kind": "attribute",
      "signature": "CONSOLE_WIDTH",
      "description": ""
    },
    {
      "name": "DEFAULT_LEVEL",
      "kind": "attribute",
      "signature": "DEFAULT_LEVEL",
      "description": ""
    },
    {
      "name": "DEFAULT_LOG_STYLES",
      "kind": "attribute",
      "signature": "DEFAULT_LOG_STYLES",
      "description": ""
    },
    {
      "name": "get_aware_datetime",
      "kind": "function",
      "signature": "get_aware_datetime() -> datetime",
      "description": "Get an aware current local datetime(with local timezone info)"
    },
    {
      "name": "get_logging_console",
      "kind": "function",
      "signature": "get_logging_console() -> Console",
      "description": "Get console from logging handlers."
    },
    {
      "name": "log",
      "kind": "attribute",
      "signature": "log",
      "description": ""
    },
    {
      "name": "LogLevel",
      "kind": "attribute",
      "signature": "LogLevel",
      "description": ""
    },
    {
      "name": "LogValue",
      "kind": "attribute",
      "signature": "LogValue",
      "description": ""
    },
    {
      "name": "Progress",
      "kind": "function",
      "signature": "Progress(console: Console, show_progress: bool) -> Iterator[RichProgress | NoOpProgress]",
      "description": "Progress manager that wraps `rich.Progress` if `show_progress` is `True`, and `NoOpProgress` otherwise."
    },
    {
      "name": "set_log_suppression",
      "kind": "function",
      "signature": "set_log_suppression(value: bool) -> None",
      "description": "Control log suppression for repeated messages."
    },
    {
      "name": "set_logging_console",
      "kind": "function",
      "signature": "set_logging_console(stderr: bool = False) -> None",
      "description": "Set stdout or stderr as console output"
    },
    {
      "name": "set_logging_file",
      "kind": "function",
      "signature": "set_logging_file(fname: PathLike, filemode: str = 'w', level: LogValue = DEFAULT_LEVEL, log_path: bool = False) -> None",
      "description": "Set a file to write log to, independently from the stdout and stderr output chosen using `set_logging_level`."
    },
    {
      "name": "set_logging_level",
      "kind": "function",
      "signature": "set_logging_level(level: LogValue = DEFAULT_LEVEL) -> None",
      "description": "Set tidy3d console logging level priority."
    },
    {
      "name": "set_warn_once",
      "kind": "function",
      "signature": "set_warn_once(value: bool) -> None",
      "description": "Control whether warnings are only shown once per unique message."
    }
  ],
  "group": "flex_rf.tidy3d"
}