.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "DMYPY" "1" "Dec 21, 2023" "" "Mypy"
.SH NAME
dmypy \- mypy daemon mode client
.SH SYNOPSIS
.sp
\fBdmypy\fP [OPTIONS...] \fICOMMAND\fP] [COMMAND OPTIONS ...]
.SH DESCRIPTION
.sp
Mypy can run as a long\-running daemon (server) process allowing to perform
type checking much faster, since program state cached from previous runs
is kept in memory and doesn’t have to be read from the file system
on each run. The server also uses finer\-grained dependency tracking to
reduce the amount of work that needs to be done.
.sp
If you have a large codebase to check, running mypy using the mypy daemon
can be 10 or more times faster than the regular command\-line \fBmypy\fP tool,
especially if your workflow involves running mypy repeatedly after
small edits – which is often a good idea, as this way you’ll find
errors sooner.
.sp
Dmypy is a command\-line client to send type\-checking requests to the server.
.SH COMMANDS
.SS start [\-\-log\-file \fIFILE\fP] [\-\-timeout \fITIMEOUT\fP] \fIARGS\fP\&...
.sp
Start a mypy daemon.
.sp
Runs a new mypy daemon, passing regular mypy flags to it.
If \fI\-\-log\-file\fP is used, directs daemon stdout/stderr to \fIFILE\fP\&.
\fI\-\-timeout\fP specifies the server shutdown timeout in seconds.
.SS stop
.sp
Stop a mypy daemon.
.sp
Politely asks the currently running mypy daemon to go away.
.SS kill
.sp
Kill a mypy daemon.
.sp
Kills the process of the currently running mypy daemon.
.SS restart [\-\-log\-file \fIFILE\fP] [\-\-timeout \fITIMEOUT\fP] \fIARGS\fP\&...
.sp
Restart a mypy daemon.
.sp
Stops the existing and then runs a new mypy daemon, passing regular mypy flags to it.
If \fI\-\-log\-file\fP is used, directs daemon stdout/stderr to \fIFILE\fP\&.
\fI\-\-timeout\fP specifies the server shutdown timeout in seconds.
.SS status [\-v]
.sp
Show a mypy daemon status.
.sp
If \fI\-v\fP or \fI\-\-verbose\fP is used, prints detailed status.
.SS daemon [\-\-timeout \fITIMEOUT\fP] \fIARGS\fP\&...
.sp
Run a mypy daemon in the foreground, passing regular mypy flags to it.
.sp
\fI\-\-timeout\fP specifies the server shutdown timeout in seconds.
.SS check [\-v] [\-\-junit\-xml \fIJUNIT_XML\fP] [\-\-perf\-stats\-file \fIPERF_STATS_FILE\fP] \fIFILE\fP [\fIFILE\fP ...]
.sp
Check some files.
.sp
Tell the currently running mypy daemon to check some files. This requires the daemon to already be running.
.INDENT 0.0
.TP
.B  \-v\fP,\fB  \-\-verbose
Print detailed status
.TP
.BI \-\-junit\-xml \ JUNIT_XML
Write junit.xml to the given file
.TP
.BI \-\-perf\-stats\-file \ PERF_STATS_FILE
Write telemetry information to the given file
.UNINDENT
.SS recheck [\-v] [\-\-junit\-xml \fIJUNIT_XML\fP] [\-\-perf\-stats\-file \fIPERF_STATS_FILE\fP] [\-\-update \fIFILE\fP [\fIFILE\fP ...]] [\-\-remove \fIFILE\fP [\fIFILE\fP ...]]
.sp
Re\-check the previous list of files, with optional modifications. This requires the daemon to already be running.
.INDENT 0.0
.TP
.B  \-v\fP,\fB  \-\-verbose
Print detailed status
.TP
.BI \-\-junit\-xml \ JUNIT_XML
Write junit.xml to the given file
.TP
.BI \-\-perf\-stats\-file \ PERF_STATS_FILE
Write telemetry information to the given file
.UNINDENT
.SS run [\-v] [\-\-junit\-xml \fIJUNIT_XML\fP] [\-\-perf\-stats\-file \fIPERF_STATS_FILE\fP] [\-\-timeout \fITIMEOUT\fP] [\-\-log\-file \fIFILE\fP] \fIARGS\fP\&...
.sp
Check some files, (re)starting the daemon if necessary.
.INDENT 0.0
.TP
.B  \-v\fP,\fB  \-\-verbose
Print detailed status
.TP
.BI \-\-junit\-xml \ JUNIT_XML
Write junit.xml to the given file
.TP
.BI \-\-perf\-stats\-file \ PERF_STATS_FILE
Write telemetry information to the given file
.TP
.BI \-\-timeout \ TIMEOUT
Server shutdown timeout (in seconds)
.TP
.BI \-\-log\-file \ FILE
Direct daemon stdout/stderr to \fIFILE\fP
.UNINDENT
.SS hang
.sp
Hang for 100 seconds.
.SH OPTIONS
.INDENT 0.0
.TP
.B \fB\-h\fP, \fB\-\-help\fP
Show a help message and exit.
.TP
.B \fB\-\-status\-file\fP \fISTATUS_FILE\fP
Status file to retrieve daemon details to.
.TP
.B \fB\-V\fP, \fB\-\-version\fP
Show program’s version number and exit.
.UNINDENT
.SH SEE ALSO
.sp
\fBmypy\fP(1)
.sp
Full documentation is available online at: \fI\%https://mypy.readthedocs.io/en/latest/mypy_daemon.html\fP
or locally at: \fI\%/usr/share/doc/mypy/html\fP (requires \fImypy\-doc\fP package).
.SH AUTHOR
Jukka Lehtosalo and contributors
.\" Generated by docutils manpage writer.
.