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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
|
""" Invoke tasks for imageio-ffmpeg
"""
import importlib
import os
import shutil
import subprocess
import sys
from urllib.request import urlopen
from invoke import task
# ---------- Per project config ----------
NAME = "imageio-ffmpeg"
LIBNAME = NAME.replace("-", "_")
PY_PATHS = [LIBNAME, "tests", "tasks.py", "setup.py"] # for linting/formatting
# ----------------------------------------
ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
if not os.path.isdir(os.path.join(ROOT_DIR, LIBNAME)):
sys.exit("package NAME seems to be incorrect.")
@task
def test(ctx, cover=False):
"""Perform unit tests. Use --cover to open a webbrowser to show coverage."""
cmd = [sys.executable, "-m", "pytest", "tests", "-v"]
cmd += ["--cov=" + LIBNAME, "--cov-report=term", "--cov-report=html"]
ret_code = subprocess.call(cmd, cwd=ROOT_DIR)
if ret_code:
sys.exit(ret_code)
if cover:
import webbrowser
webbrowser.open(os.path.join(ROOT_DIR, "htmlcov", "index.html"))
@task
def lint(ctx):
"""Validate the code style (e.g. undefined names)"""
try:
importlib.import_module("flake8")
except ImportError:
sys.exit("You need to ``pip install flake8`` to lint")
print("Checking linting errors with flake8:")
# We use flake8 with minimal settings
# http://pep8.readthedocs.io/en/latest/intro.html#error-codes
cmd = [sys.executable, "-m", "flake8"] + PY_PATHS + ["--select=F,E11"]
ret_code = subprocess.call(cmd, cwd=ROOT_DIR)
if ret_code == 0:
print("No linting errors found")
else:
sys.exit(ret_code)
@task
def checkformat(ctx):
"""Check whether the code adheres to the style rules. Use autoformat to fix."""
print("Checking format with black (also see invoke autoformat):")
black_wrapper(False)
@task
def autoformat(ctx):
"""Automatically format the code (using black)."""
print("Auto-formatting with black:")
black_wrapper(True)
@task
def clean(ctx):
"""Clean the repo of temp files etc."""
for root, dirs, files in os.walk(ROOT_DIR):
for dname in dirs:
if dname in (
"__pycache__",
".cache",
"htmlcov",
".hypothesis",
".pytest_cache",
"dist",
"build",
LIBNAME + ".egg-info",
):
shutil.rmtree(os.path.join(root, dname))
print("Removing", dname)
for fname in files:
if fname.endswith((".pyc", ".pyo")) or fname in (".coverage"):
os.remove(os.path.join(root, fname))
print("Removing", fname)
##
@task
def get_ffmpeg_binary(ctx):
"""Download/copy ffmpeg binary for local development."""
# Get ffmpeg fname
sys.path.insert(0, os.path.join(ROOT_DIR, "imageio_ffmpeg"))
try:
from _definitions import FNAME_PER_PLATFORM, get_platform
finally:
sys.path.pop(0)
fname = FNAME_PER_PLATFORM[get_platform()]
# Clear
clear_binaries_dir(os.path.join(ROOT_DIR, "imageio_ffmpeg", "binaries"))
# Use local if we can (faster)
source_dir = os.path.abspath(
os.path.join(ROOT_DIR, "..", "imageio-binaries", "ffmpeg")
)
if os.path.isdir(source_dir):
copy_binaries(os.path.join(ROOT_DIR, "imageio_ffmpeg", "binaries"), fname)
return
# Download from Github
base_url = "https://github.com/imageio/imageio-binaries/raw/master/ffmpeg/"
filename = os.path.join(ROOT_DIR, "imageio_ffmpeg", "binaries", fname)
print("Downloading", fname, "...", end="")
with urlopen(base_url + fname, timeout=5) as f1:
with open(filename, "wb") as f2:
shutil.copyfileobj(f1, f2)
# Mark executable
os.chmod(filename, os.stat(filename).st_mode | 64)
print("done")
@task
def build(ctx):
"""Build packages for different platforms. Dont release yet."""
# Get version and more
sys.path.insert(0, os.path.join(ROOT_DIR, "imageio_ffmpeg"))
try:
from _definitions import FNAME_PER_PLATFORM, WHEEL_BUILDS, __version__
finally:
sys.path.pop(0)
# Clear up any build artifacts
clean(ctx)
# Clear binaries, we don't want them in the reference release
clear_binaries_dir(
os.path.abspath(os.path.join(ROOT_DIR, "imageio_ffmpeg", "binaries"))
)
# Now build a universal wheel
print("Using setup.py to generate wheel... ", end="")
subprocess.check_output(
[sys.executable, "setup.py", "sdist", "bdist_wheel"], cwd=ROOT_DIR
)
print("done")
# Prepare
dist_dir = os.path.join(ROOT_DIR, "dist")
fname = "imageio_ffmpeg-" + __version__ + "-py3-none-any.whl"
packdir = "imageio_ffmpeg-" + __version__
infodir = "imageio_ffmpeg-" + __version__ + ".dist-info"
wheelfile = os.path.join(dist_dir, packdir, infodir, "WHEEL")
assert os.path.isfile(os.path.join(dist_dir, fname))
# Unpack
print("Unpacking ... ", end="")
subprocess.check_output(
[sys.executable, "-m", "wheel", "unpack", fname], cwd=dist_dir
)
os.remove(os.path.join(dist_dir, packdir, infodir, "RECORD"))
print("done")
# Build for different platforms
for wheeltag, platform in WHEEL_BUILDS.items():
ffmpeg_fname = FNAME_PER_PLATFORM[platform]
# Edit
print("Edit for {} ({})".format(platform, wheeltag))
copy_binaries(
os.path.join(dist_dir, packdir, "imageio_ffmpeg", "binaries"), ffmpeg_fname
)
make_platform_specific(wheelfile, wheeltag)
# Pack
print("Pack ... ", end="")
subprocess.check_output(
[sys.executable, "-m", "wheel", "pack", packdir], cwd=dist_dir
)
print("done")
# Clean up
os.remove(os.path.join(dist_dir, fname))
shutil.rmtree(os.path.join(dist_dir, packdir))
# Show overview
print("Dist folder:")
for fname in sorted(os.listdir(dist_dir)):
s = os.stat(os.path.join(dist_dir, fname)).st_size
print(" {:0.0f} KiB {}".format(s / 2**10, fname))
if sys.platform.startswith("win"):
print("Note that the exes for Linux/OSX are not chmodded properly!")
@task
def release(ctx):
"""Release the packages to Pypi!"""
dist_dir = os.path.join(ROOT_DIR, "dist")
if not os.path.isdir(dist_dir):
sys.exit("Dist directory does not exist. Build first?")
print("This is what you are about to upload:")
for fname in sorted(os.listdir(dist_dir)):
s = os.stat(os.path.join(dist_dir, fname)).st_size
print(" {:0.0f} KiB {}".format(s / 2**10, fname))
while True:
x = input("Are you sure you want to upload now? [Y/N]: ")
if x.upper() == "N":
return
elif x.upper() == "Y":
break
if sys.platform.startswith("win"):
sys.exit("Cannot release from Windows: the exes wont be chmodded properly!")
subprocess.check_call([sys.executable, "-m", "twine", "upload", "dist/*"])
@task
def update_readme(ctx):
"""Update readme to include the latest API docs."""
text = open(os.path.join(ROOT_DIR, "README.md"), "rb").read().decode()
text = text.split("\n## API\n")[0] + "\n## API\n\n"
import inspect
import imageio_ffmpeg
for func in (
imageio_ffmpeg.read_frames,
imageio_ffmpeg.write_frames,
imageio_ffmpeg.count_frames_and_secs,
imageio_ffmpeg.get_ffmpeg_exe,
imageio_ffmpeg.get_ffmpeg_version,
):
source = inspect.getsourcelines(func)[0]
stripped = [x.strip() for x in source]
end = stripped.index('"""', stripped.index('"""') + 1) + 1
text += "```py\n" + "".join(source[:end]) + "```\n\n"
with open(os.path.join(ROOT_DIR, "README.md"), "wb") as f:
f.write(text.encode())
##
def black_wrapper(writeback):
"""Helper function to invoke black programatically."""
check = [] if writeback else ["--check"]
exclude = "|".join([".git"])
sys.argv[1:] = check + ["--exclude", exclude, ROOT_DIR]
import black
black.main()
def clear_binaries_dir(target_dir):
assert os.path.isdir(target_dir)
for fname in os.listdir(target_dir):
if fname not in ["README.md", "__init__.py"]:
print("Removing", fname, "...", end="")
os.remove(os.path.join(target_dir, fname))
print("done")
def copy_binaries(target_dir, fname):
# Get source dir - the imageio-binaries repo must be present
source_dir = os.path.abspath(
os.path.join(ROOT_DIR, "..", "imageio-binaries", "ffmpeg")
)
if not os.path.isdir(source_dir):
sys.exit("Need to clone imageio-binaries next to this repo to do a release!")
clear_binaries_dir(target_dir)
print("Copying", fname, "...", end="")
filename = os.path.join(target_dir, fname)
shutil.copy2(os.path.join(source_dir, fname), filename)
# Mark as exe. This does not actually do anything on Windows.
os.chmod(filename, os.stat(filename).st_mode | 64)
print("done")
def make_platform_specific(filename, tag):
with open(filename, "rb") as f:
text = f.read().decode()
lines = []
for line in text.splitlines():
if line.startswith("Root-Is-Purelib:"):
line = "Root-Is-Purelib: true"
elif line.startswith("Tag:"):
line = "Tag: " + tag
lines.append(line)
text = "\n".join(lines).strip() + "\n"
with open(filename, "wb") as f:
f.write(text.encode())
|