<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[15538] twext/trunk/twext/python/usage.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/15538">15538</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2016-04-21 12:48:22 -0700 (Thu, 21 Apr 2016)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add usage</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#twexttrunktwextpythonusagepy">twext/trunk/twext/python/usage.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextpythonusagepy"></a>
<div class="addfile"><h4>Added: twext/trunk/twext/python/usage.py (0 => 15538)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/python/usage.py (rev 0)
+++ twext/trunk/twext/python/usage.py 2016-04-21 19:48:22 UTC (rev 15538)
</span><span class="lines">@@ -0,0 +1,276 @@
</span><ins>+##
+# Copyright (c) 2016 Apple Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+"""
+Command line usage.
+"""
+
+__all__ = [
+ "Executable",
+ "Options",
+ "UsageError",
+ "exit",
+ "ExitStatus",
+]
+
+import sys
+import signal
+from os import getpid, kill
+
+from twisted.python.constants import Values, ValueConstant
+from twisted.python.usage import Options as TwistedOptions, UsageError
+from twisted.python.filepath import FilePath
+from twisted.logger import (
+ globalLogBeginner, textFileLogObserver, jsonFileLogObserver,
+ FilteringLogObserver, LogLevelFilterPredicate,
+ LogLevel, InvalidLogLevelError,
+ Logger,
+)
+
+
+
+class Executable(object):
+ """
+ Executable.
+ """
+
+ log = Logger()
+
+
+ @classmethod
+ def main(cls, argv=sys.argv):
+ if hasattr(cls, "Options"):
+ options = cls.Options()
+
+ try:
+ options.parseOptions(argv[1:])
+ except UsageError as e:
+ exit(ExitStatus.EX_USAGE, "Error: {}\n\n{}".format(e, options))
+
+ else:
+ options = None
+
+ instance = cls(options)
+
+ pidFile = options.get("pidFile")
+
+ if options.get("kill"):
+ if pidFile is None:
+ exit(ExitStatus.EX_USAGE, "--pid-file required to use --kill")
+ else:
+ pid = ""
+ try:
+ for pid in pidFile.open():
+ break
+ except (IOError, OSError):
+ exit(ExitStatus.EX_DATAERR, "Unable to read pid file.")
+ try:
+ pid = int(pid)
+ except ValueError:
+ exit(ExitStatus.EX_DATAERR, "Invalid pid file.")
+
+ instance.startLogging()
+ cls.log.info("Terminating process: {pid}", pid=pid)
+
+ kill(pid, signal.SIGTERM)
+
+ exit(ExitStatus.EX_OK)
+
+ if pidFile is not None:
+ pid = getpid()
+ pidFile.setContent(u"{}\n".format(pid).encode("utf-8"))
+
+ instance.startLogging()
+ from twisted.internet import reactor
+ reactor.callWhenRunning(instance.whenRunning)
+ instance.run()
+ instance.tearDown()
+
+
+ def __init__(self, options):
+ self.options = options
+
+
+ def startLogging(self):
+ logFile = self.options.get("logFile", sys.stderr)
+
+ fileLogObserverFactory = self.options.get(
+ "fileLogObserverFactory", textFileLogObserver
+ )
+
+ fileObserver = fileLogObserverFactory(logFile)
+
+ logLevelPredicate = LogLevelFilterPredicate(
+ defaultLogLevel=self.options.get("logLevel", LogLevel.info)
+ )
+
+ filteringObserver = FilteringLogObserver(
+ fileObserver, [logLevelPredicate]
+ )
+
+ globalLogBeginner.beginLoggingTo([filteringObserver])
+
+
+ def whenRunning(self):
+ pass
+
+
+ def run(self):
+ from twisted.internet import reactor
+ self.log.info("Starting reactor...")
+ reactor.run()
+
+
+ def tearDown(self):
+ pidFile = self.options.get("pidFile")
+ if pidFile is not None:
+ pidFile.remove()
+
+
+
+class Options(TwistedOptions):
+ """
+ Options.
+ """
+
+ def opt_version(self):
+ """
+ Print version and exit.
+ """
+ from deps import __version__ as version
+ exit(ExitStatus.EX_OK, "{}".format(version))
+
+
+ def opt_pid_file(self, name):
+ """
+ File to store process ID in.
+ """
+ self["pidFile"] = FilePath(name)
+
+
+ def opt_kill(self):
+ """
+ Exit running application. (Requires --pid-file.)
+ """
+ self["kill"] = True
+
+
+ def opt_log_file(self, fileName):
+ """
+ Log to file.
+
+ ("-" for stdout, "+" for stderr. default: "+")
+ """
+ if fileName == "-":
+ self["logFile"] = sys.stdout
+ return
+
+ if fileName == "+":
+ self["logFile"] = sys.stderr
+ return
+
+ try:
+ self["logFile"] = open(fileName, "w")
+ self.setdefault("fileLogObserverFactory", jsonFileLogObserver)
+ except EnvironmentError as e:
+ exit(
+ ExitStatus.EX_CANTCREAT,
+ "Unable to open log file {!r}: {}".format(fileName, e)
+ )
+
+
+ def opt_log_format(self, format):
+ """
+ Set log file format to one of: (text, json).
+
+ (default: text for stdout/stderr, otherwise json)
+ """
+ format = format.lower()
+
+ if format == "text":
+ self["fileLogObserverFactory"] = textFileLogObserver
+ elif format == "json":
+ self["fileLogObserverFactory"] = jsonFileLogObserver
+ else:
+ exit(
+ ExitStatus.EX_USAGE,
+ "Invalid log format: {}".format(format)
+ )
+
+
+ def opt_log_level(self, levelName):
+ """
+ Set default log level to one of: {levelNames}.
+
+ (default: info)
+ """
+ try:
+ self["logLevel"] = LogLevel.levelWithName(levelName)
+ except InvalidLogLevelError:
+ exit(
+ ExitStatus.EX_USAGE,
+ "Invalid log level: {}".format(levelName)
+ )
+
+
+ # Format the docstring for opt_logLevel.
+ opt_log_level.__doc__ = opt_log_level.__doc__.format(
+ levelNames=", ".join([l.name for l in LogLevel.iterconstants()])
+ )
+
+
+
+def exit(status, message=None):
+ """
+ Exit the python interpreter.
+ """
+ if message:
+ if status == ExitStatus.EX_OK:
+ out = sys.stdout
+ else:
+ out = sys.stderr
+ out.write(message)
+ out.write("\n")
+
+ sys.exit(status.value)
+
+
+
+class ExitStatus(Values):
+ """
+ Exit status codes for system programs.
+ """
+
+ EX__BASE = 64
+
+ EX_OK = ValueConstant(0) # No error
+ EX_USAGE = ValueConstant(EX__BASE) # Command line usage error
+ EX_DATAERR = ValueConstant(EX__BASE + 1) # Invalid user data
+ EX_NOINPUT = ValueConstant(EX__BASE + 2) # Can't open input file
+ EX_NOUSER = ValueConstant(EX__BASE + 3) # Can't look up user
+ EX_NOHOST = ValueConstant(EX__BASE + 4) # Can't look up host
+ EX_UNAVAILABLE = ValueConstant(EX__BASE + 5) # Service unavailable
+ EX_SOFTWARE = ValueConstant(EX__BASE + 6) # Internal software error
+ EX_OSERR = ValueConstant(EX__BASE + 7) # System error
+ EX_OSFILE = ValueConstant(EX__BASE + 8) # System file missing
+ EX_CANTCREAT = ValueConstant(EX__BASE + 9) # Can't create output file
+ EX_IOERR = ValueConstant(EX__BASE + 10) # I/O error
+ EX_TEMPFAIL = ValueConstant(EX__BASE + 11) # Temporary failure
+ EX_PROTOCOL = ValueConstant(EX__BASE + 12) # Remote protocol error
+ EX_NOPERM = ValueConstant(EX__BASE + 13) # Permission denied
+ EX_CONFIG = ValueConstant(EX__BASE + 14) # Configuration error
+
+ EX__MAX = EX_CONFIG.value
</ins></span></pre>
</div>
</div>
</body>
</html>