/usr/lib/python3/dist-packages/cloud_sptheme/make_helper.py is in python3-cloud-sptheme 1.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | """helper for quick cross-platform makefile for sphinx
TODO: this was hacked up really quickly, could use lots of work.
"""
#===============================================================
#imports
#===============================================================
#core
from __future__ import print_function
import logging; log = logging.getLogger(__name__)
import os,sys
from string import Template
import subprocess
#pkg
#local
__all__ = [
"SphinxMaker",
]
#===============================================================
#misc helpers
#===============================================================
def sub(fmt, **kwds):
if not kwds:
kwds = globals()
return Template(fmt).substitute(**kwds)
#===============================================================
#fs helpers
#===============================================================
joinpath = os.path.join
def abspath(*args):
return os.path.abspath(joinpath(*args))
if hasattr(os.path, "realpath"):
def realpath(*args):
return os.path.realpath(joinpath(*args))
else:
#probably windows - fake it best we can
def realpath(*args):
return os.path.normcase(os.path.abspath(joinpath(*args)))
def pathdir(path):
return os.path.split(path)[0]
def clearpath(path):
"recursively remove all contents of dir, but leave dir"
for root, dirs, files in os.walk(path, topdown=False):
for name in files:
os.remove(joinpath(root, name))
for name in dirs:
os.rmdir(joinpath(root, name))
def rmpath(path):
"drecursively delete path"
if os.path.exists(path):
if os.path.isdir(path):
clearpath(path)
os.rmdir(path)
else:
os.remove(path)
def ensuredirs(path):
"ensure specified directory & all parents exist"
if not os.path.isdir(path):
os.makedirs(path)
#===============================================================
#main class
#===============================================================
class SphinxMaker(object):
#===============================================================
#class attrs
#===============================================================
# You can subclass these variables
SPHINXOPTS = []
SPHINXBUILD = "sphinx-build"
PAPER = "letter"
SERVEHTML_PORT = 8000
# Paths
BUILD = "_build"
SOURCE = "."
#internal opts
PAPEROPT_a4 = ["-D","latex_paper_size=a4"]
PAPEROPT_letter = ["-D","latex_paper_size=letter"]
#: list of attrs to check os.environ for overriddes.
env_vars = [ "SPHINXOPTS", "SPHINXBUILD", "PAPER", "SERVEHTML_PORT", "BUILD", "SOURCE" ]
#===============================================================
#instance attrs
#===============================================================
root_dir = None
conf_file = None
conf = None
#===============================================================
#frontend
#===============================================================
def __init__(self, root_dir=None, **kwds):
#FIXME: this may not be properly flexible.
if root_dir is None:
root_dir = joinpath(sys.modules["__main__"].__file__, os.pardir)
self.root_dir = abspath(root_dir)
self.conf_file = joinpath(self.root_dir, "conf.py")
if not os.path.exists(self.conf_file):
raise RuntimeError("conf file not found in root: %r" %
(self.root_dir))
#check environment for overrides, as well as constructor
for key in self.env_vars:
value = kwds.pop(key, None)
value = os.environ.get(key, value)
if value is not None:
t = type(getattr(self,key))
#FIXME: this is *real* hacked way to do type conversion
if isinstance(t, str):
if isinstance(t, int): #for ints, eg SERVEHTML_PORT
value = int(t)
elif isinstance(t, list): #for list of arguments, eg SPHINXOPTS
#FIXME: should use proper quote escaping logic when we split :(
value = " ".split(value)
setattr(self, key, value)
# make all relative paths relative to root dir
for name in ("BUILD", "SOURCE"):
value = getattr(self, name)
if not os.path.isabs(value):
value = abspath(self.root_dir, value)
setattr(self, name, value)
if kwds:
raise TypeError("unknown keywords: %r" % (kwds,))
@classmethod
def execute(cls, args=None, **kwds):
return cls(**kwds).run(args)
def run(self, args=None):
if args is None:
args = sys.argv[1:]
os.chdir(self.root_dir) #due to relative paths like self.BUILD
for arg in args:
getattr(self,"target_"+arg)()
#===============================================================
#targets
#===============================================================
def target_help(self):
print("Please use \`make <target>' where <target> is one of")
print(" clean remove all compiled files")
print(" html to make standalone HTML files")
print(" servehtml to serve standalone HTML files on port 8000")
# print(" pickle to make pickle files")
# print(" json to make JSON files")
print(" htmlhelp to make HTML files and a HTML help project")
# print(" latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter")
# print(" changes to make an overview over all changed/added/deprecated items")
# print(" linkcheck to check all external links for integrity")
def target_clean(self):
rmpath(self.BUILD)
def target_html(self):
self.build("html")
def target_htmlhelp(self):
self.build("htmlhelp")
def target_servehtml(self):
path = realpath(self.BUILD, "html")
port = self.SERVEHTML_PORT
# try to use paste
try:
from paste.httpserver import serve
from paste.urlparser import StaticURLParser
except ImportError:
# fall back to stdlib server
if sys.version_info[0] >= 3:
import http.server as s
HTTPServer = s.HTTPServer
else:
import SimpleHTTPServer as s
HTTPServer = s.BaseHTTPServer.HTTPServer
os.chdir(path)
print("Serving files from %r on port %r" % (path, port))
HTTPServer(('',port), s.SimpleHTTPRequestHandler).serve_forever()
else:
serve(StaticURLParser(path), host="0.0.0.0", port=port)
#TODO: support latex, pdf, etc...
##def target_latex(self):
## build("latex")
## print("Run \`make all-pdf' or \`make all-ps' in that directory to" \
## "run these through (pdf)latex.")
##
##def target_pdf():
## assert os.name == "posix", "pdf build support not automated for your os"
## build("latex")
## target = BUILD / "latex"
## target.chdir()
## subprocess.call(['make', 'all-pdf'])
## print("pdf built")
#===============================================================
#helpers
#===============================================================
def build(self, name):
BUILD = self.BUILD
ALLSPHINXOPTS = self.get_sphinx_opts()
dt = joinpath(BUILD, "doctrees")
ensuredirs(dt)
target = joinpath(BUILD, name)
ensuredirs(target)
rc = subprocess.call([self.SPHINXBUILD, "-b", name] + ALLSPHINXOPTS + [ target ])
if rc:
print("Sphinx-Build returned error, exiting.")
sys.exit(rc)
print("Build finished. The %s pages are in %r." % (name, target,))
return target
def get_paper_opts(self):
return getattr(self,"PAPER_" + self.PAPER, [])
def get_sphinx_opts(self):
return ["-d", joinpath(self.BUILD, "doctrees")] + self.get_paper_opts() + self.SPHINXOPTS + [ self.SOURCE ]
#===============================================================
#eoc
#===============================================================
class ProjectSphinxMaker(SphinxMaker):
"SphinxMaker variant which more usefully integrates into setup.py of a python project"
#TODO: make this read setup.cfg etc to see where build_sphinx *actually* puts things
BUILD = os.path.join(os.pardir, "build", "sphinx")
#===============================================================
#eof
#===============================================================
|