python-bigquery/noxfile.py at main · Python-Repository-Hub/python-bigquery · GitHub

History

430 lines (354 loc) · 13.3 KB

Raw

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

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

# 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.

from __future__ import absolute_import

import pathlib

import os

import re

import shutil

import nox

MYPY_VERSION = "mypy==0.910"

PYTYPE_VERSION = "pytype==2021.4.9"

BLACK_VERSION = "black==22.3.0"

BLACK_PATHS = ("docs", "google", "samples", "tests", "noxfile.py", "setup.py")

DEFAULT_PYTHON_VERSION = "3.8"

SYSTEM_TEST_PYTHON_VERSIONS = ["3.8", "3.10"]

UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]

CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()

# 'docfx' is excluded since it only needs to run in 'docs-presubmit'

nox.options.sessions = [

"unit_noextras",

"unit",

"system",

"snippets",

"cover",

"lint",

"lint_setup_py",

"blacken",

"mypy",

"mypy_samples",

"pytype",

"docs",

]

def default(session, install_extras=True):

"""Default unit test session.

This is intended to be run **without** an interpreter set, so

that the current ``python`` (on the ``PATH``) or the version of

Python corresponding to the ``nox`` binary the ``PATH`` can

run the tests.

"""

constraints_path = str(

CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"

)

# Install all test dependencies, then install local packages in-place.

session.install(

"mock",

"pytest",

"google-cloud-testutils",

"pytest-cov",

"freezegun",

"-c",

constraints_path,

)

if install_extras and session.python == "3.10":

install_target = ".[bqstorage,pandas,tqdm,opentelemetry]"

elif install_extras:

install_target = ".[all]"

else:

install_target = "."

session.install("-e", install_target, "-c", constraints_path)

# Run py.test against the unit tests.

session.run(

"py.test",

"--quiet",

"--cov=google/cloud/bigquery",

"--cov=tests/unit",

"--cov-append",

"--cov-config=.coveragerc",

"--cov-report=",

"--cov-fail-under=0",

os.path.join("tests", "unit"),

*session.posargs,

)

@nox.session(python=UNIT_TEST_PYTHON_VERSIONS)

def unit(session):

"""Run the unit test suite."""

default(session)

@nox.session(python=[UNIT_TEST_PYTHON_VERSIONS[0], UNIT_TEST_PYTHON_VERSIONS[-1]])

def unit_noextras(session):

"""Run the unit test suite."""

# Install optional dependencies that are out-of-date.

# https://github.com/googleapis/python-bigquery/issues/933

# There is no pyarrow 1.0.0 package for Python 3.9.

if session.python == UNIT_TEST_PYTHON_VERSIONS[0]:

session.install("pyarrow==1.0.0")

default(session, install_extras=False)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def mypy(session):

"""Run type checks with mypy."""

session.install("-e", ".[all]")

session.install(MYPY_VERSION)

# Just install the dependencies' type info directly, since "mypy --install-types"

# might require an additional pass.

session.install(

"types-protobuf",

"types-python-dateutil",

"types-requests",

"types-setuptools",

)

session.run("mypy", "google/cloud")

@nox.session(python=DEFAULT_PYTHON_VERSION)

def pytype(session):

"""Run type checks with pytype."""

# An indirect dependecy attrs==21.1.0 breaks the check, and installing a less

# recent version avoids the error until a possibly better fix is found.

# https://github.com/googleapis/python-bigquery/issues/655

session.install("attrs==20.3.0")

session.install("-e", ".[all]")

session.install(PYTYPE_VERSION)

session.run("pytype")

@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)

def system(session):

"""Run the system test suite."""

constraints_path = str(

CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"

)

# Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true.

if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false":

session.skip("RUN_SYSTEM_TESTS is set to false, skipping")

# Sanity check: Only run system tests if the environment variable is set.

if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""):

session.skip("Credentials must be set via environment variable.")

# Use pre-release gRPC for system tests.

session.install("--pre", "grpcio", "-c", constraints_path)

# Install all test dependencies, then install local packages in place.

session.install(

"mock", "pytest", "psutil", "google-cloud-testutils", "-c", constraints_path

)

if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "") == "true":

# mTLS test requires pyopenssl and latest google-cloud-storage

session.install("google-cloud-storage", "pyopenssl")

else:

session.install("google-cloud-storage", "-c", constraints_path)

# Data Catalog needed for the column ACL test with a real Policy Tag.

session.install("google-cloud-datacatalog", "-c", constraints_path)

if session.python == "3.10":

extras = "[bqstorage,pandas,tqdm,opentelemetry]"

else:

extras = "[all]"

session.install("-e", f".{extras}", "-c", constraints_path)

# Run py.test against the system tests.

session.run("py.test", "--quiet", os.path.join("tests", "system"), *session.posargs)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def mypy_samples(session):

"""Run type checks with mypy."""

session.install("-e", ".[all]")

session.install("ipython", "pytest")

session.install(MYPY_VERSION)

# Just install the dependencies' type info directly, since "mypy --install-types"

# might require an additional pass.

session.install("types-mock", "types-pytz")

session.install("typing-extensions") # for TypedDict in pre-3.8 Python versions

session.run(

"mypy",

"--config-file",

str(CURRENT_DIRECTORY / "samples" / "mypy.ini"),

"--no-incremental", # Required by warn-unused-configs from mypy.ini to work

"samples/",

)

@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)

def snippets(session):

"""Run the snippets test suite."""

# Check the value of `RUN_SNIPPETS_TESTS` env var. It defaults to true.

if os.environ.get("RUN_SNIPPETS_TESTS", "true") == "false":

session.skip("RUN_SNIPPETS_TESTS is set to false, skipping")

constraints_path = str(

CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt"

)

# Install all test dependencies, then install local packages in place.

session.install("mock", "pytest", "google-cloud-testutils", "-c", constraints_path)

session.install("google-cloud-storage", "-c", constraints_path)

session.install("grpcio", "-c", constraints_path)

if session.python == "3.10":

extras = "[bqstorage,pandas,tqdm,opentelemetry]"

else:

extras = "[all]"

session.install("-e", f".{extras}", "-c", constraints_path)

# Run py.test against the snippets tests.

# Skip tests in samples/snippets, as those are run in a different session

# using the nox config from that directory.

session.run("py.test", os.path.join("docs", "snippets.py"), *session.posargs)

session.run(

"py.test",

"samples",

"--ignore=samples/magics",

"--ignore=samples/geography",

"--ignore=samples/snippets",

*session.posargs,

)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def cover(session):

"""Run the final coverage report.

This outputs the coverage report aggregating coverage from the unit

test runs (not system test runs), and then erases coverage data.

"""

session.install("coverage", "pytest-cov")

session.run("coverage", "report", "--show-missing", "--fail-under=100")

session.run("coverage", "erase")

@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)

def prerelease_deps(session):

"""Run all tests with prerelease versions of dependencies installed.

https://github.com/googleapis/python-bigquery/issues/95

"""

# PyArrow prerelease packages are published to an alternative PyPI host.

# https://arrow.apache.org/docs/python/install.html#installing-nightly-packages

session.install(

"--extra-index-url",

"https://pypi.fury.io/arrow-nightlies/",

"--prefer-binary",

"--pre",

"--upgrade",

"pyarrow",

)

session.install(

"--extra-index-url",

"https://pypi.anaconda.org/scipy-wheels-nightly/simple",

"--prefer-binary",

"--pre",

"--upgrade",

"pandas",

)

session.install(

"--pre",

"--upgrade",

"google-api-core",

"google-cloud-bigquery-storage",

"google-cloud-core",

"google-resumable-media",

"grpcio",

)

session.install(

"freezegun",

"google-cloud-datacatalog",

"google-cloud-storage",

"google-cloud-testutils",

"IPython",

"mock",

"psutil",

"pytest",

"pytest-cov",

)

# Because we test minimum dependency versions on the minimum Python

# version, the first version we test with in the unit tests sessions has a

# constraints file containing all dependencies and extras.

with open(

CURRENT_DIRECTORY

/ "testing"

/ f"constraints-{UNIT_TEST_PYTHON_VERSIONS[0]}.txt",

encoding="utf-8",

) as constraints_file:

constraints_text = constraints_file.read()

# Ignore leading whitespace and comment lines.

deps = [

match.group(1)

for match in re.finditer(

r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE

)

]

# We use --no-deps to ensure that pre-release versions aren't overwritten

# by the version ranges in setup.py.

session.install(*deps)

session.install("--no-deps", "-e", ".[all]")

# Print out prerelease package versions.

session.run("python", "-c", "import grpc; print(grpc.__version__)")

session.run("python", "-c", "import pandas; print(pandas.__version__)")

session.run("python", "-c", "import pyarrow; print(pyarrow.__version__)")

# Run all tests, except a few samples tests which require extra dependencies.

session.run("py.test", "tests/unit")

session.run("py.test", "tests/system")

session.run("py.test", "samples/tests")

@nox.session(python=DEFAULT_PYTHON_VERSION)

def lint(session):

"""Run linters.

Returns a failure if the linters find linting errors or sufficiently

serious code quality issues.

"""

session.install("flake8", BLACK_VERSION)

session.install("-e", ".")

session.run("flake8", os.path.join("google", "cloud", "bigquery"))

session.run("flake8", "tests")

session.run("flake8", os.path.join("docs", "samples"))

session.run("flake8", os.path.join("docs", "snippets.py"))

session.run("black", "--check", *BLACK_PATHS)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def lint_setup_py(session):

"""Verify that setup.py is valid (including RST check)."""

session.install("docutils", "Pygments")

session.run("python", "setup.py", "check", "--restructuredtext", "--strict")

@nox.session(python=DEFAULT_PYTHON_VERSION)

def blacken(session):

"""Run black.

Format code to uniform standard.

"""

session.install(BLACK_VERSION)

session.run("black", *BLACK_PATHS)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def docs(session):

"""Build the docs."""

session.install("recommonmark", "sphinx==4.0.1", "sphinx_rtd_theme")

session.install("google-cloud-storage")

session.install("-e", ".[all]")

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

session.run(

"sphinx-build",

"-W", # warnings as errors

"-T", # show full traceback on exception

"-N", # no colors

"-b",

"html",

"-d",

os.path.join("docs", "_build", "doctrees", ""),

os.path.join("docs", ""),

os.path.join("docs", "_build", "html", ""),

)

@nox.session(python=DEFAULT_PYTHON_VERSION)

def docfx(session):

"""Build the docfx yaml files for this library."""

session.install("-e", ".")

session.install(

"sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml"

)

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)

session.run(

"sphinx-build",

"-T", # show full traceback on exception

"-N", # no colors

"-D",

(

"extensions=sphinx.ext.autodoc,"

"sphinx.ext.autosummary,"

"docfx_yaml.extension,"

"sphinx.ext.intersphinx,"

"sphinx.ext.coverage,"

"sphinx.ext.napoleon,"

"sphinx.ext.todo,"

"sphinx.ext.viewcode,"

"recommonmark"

"-b",

"html",

"-d",

os.path.join("docs", "_build", "doctrees", ""),

os.path.join("docs", ""),

os.path.join("docs", "_build", "html", ""),

)

python-bigquery/noxfile.py at main · Python-Repository-Hub/python-bigquery · GitHub

Uh oh!

Expand file tree

Breadcrumbs

noxfile.py

Latest commit

History

Breadcrumbs

noxfile.py

File metadata and controls