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 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 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
|
import logging
import math
import re
import shlex
from .exceptions import PapermillException
from .models import Parameter
logger = logging.getLogger(__name__)
class PapermillTranslators:
'''
The holder which houses any translator registered with the system.
This object is used in a singleton manner to save and load particular
named Translator objects for reference externally.
'''
def __init__(self):
self._translators = {}
def register(self, language, translator):
self._translators[language] = translator
def find_translator(self, kernel_name, language):
if kernel_name in self._translators:
return self._translators[kernel_name]
elif language in self._translators:
return self._translators[language]
raise PapermillException(
f"No parameter translator functions specified for kernel '{kernel_name}' or language '{language}'"
)
class Translator:
@classmethod
def translate_raw_str(cls, val):
"""Reusable by most interpreters"""
return f'{val}'
@classmethod
def translate_escaped_str(cls, str_val):
"""Reusable by most interpreters"""
if isinstance(str_val, str):
str_val = str_val.encode('unicode_escape')
str_val = str_val.decode('utf-8')
str_val = str_val.replace('"', r'\"')
return f'"{str_val}"'
@classmethod
def translate_str(cls, val):
"""Default behavior for translation"""
return cls.translate_escaped_str(val)
@classmethod
def translate_none(cls, val):
"""Default behavior for translation"""
return cls.translate_raw_str(val)
@classmethod
def translate_int(cls, val):
"""Default behavior for translation"""
return cls.translate_raw_str(val)
@classmethod
def translate_float(cls, val):
"""Default behavior for translation"""
return cls.translate_raw_str(val)
@classmethod
def translate_bool(cls, val):
"""Default behavior for translation"""
return 'true' if val else 'false'
@classmethod
def translate_dict(cls, val):
raise NotImplementedError(f'dict type translation not implemented for {cls}')
@classmethod
def translate_list(cls, val):
raise NotImplementedError(f'list type translation not implemented for {cls}')
@classmethod
def translate(cls, val):
"""Translate each of the standard json/yaml types to appropriate objects."""
if val is None:
return cls.translate_none(val)
elif isinstance(val, str):
return cls.translate_str(val)
# Needs to be before integer checks
elif isinstance(val, bool):
return cls.translate_bool(val)
elif isinstance(val, int):
return cls.translate_int(val)
elif isinstance(val, float):
return cls.translate_float(val)
elif isinstance(val, dict):
return cls.translate_dict(val)
elif isinstance(val, list):
return cls.translate_list(val)
# Use this generic translation as a last resort
return cls.translate_escaped_str(val)
@classmethod
def comment(cls, cmt_str):
raise NotImplementedError(f'comment translation not implemented for {cls}')
@classmethod
def assign(cls, name, str_val):
return f'{name} = {str_val}'
@classmethod
def codify(cls, parameters, comment='Parameters'):
content = f'{cls.comment(comment)}\n'
for name, val in parameters.items():
content += f'{cls.assign(name, cls.translate(val))}\n'
return content
@classmethod
def inspect(cls, parameters_cell):
"""Inspect the parameters cell to get a Parameter list
It must return an empty list if no parameters are found and
it should ignore inspection errors.
.. note::
``inferred_type_name`` should be "None" if unknown (set it
to "NoneType" for null value)
Parameters
----------
parameters_cell : NotebookNode
Cell tagged _parameters_
Returns
-------
List[Parameter]
A list of all parameters
"""
raise NotImplementedError(f'parameters introspection not implemented for {cls}')
class PythonTranslator(Translator):
# Pattern to capture parameters within cell input
PARAMETER_PATTERN = re.compile(
r"^(?P<target>\w[\w_]*)\s*(:\s*[\"']?(?P<annotation>\w[\w_\[\],\s]*)[\"']?\s*)?=\s*(?P<value>.*?)(\s*#\s*(type:\s*(?P<type_comment>[^\s]*)\s*)?(?P<help>.*))?$"
)
@classmethod
def translate_float(cls, val):
if math.isfinite(val):
return cls.translate_raw_str(val)
elif math.isnan(val):
return "float('nan')"
elif val < 0:
return "float('-inf')"
else:
return "float('inf')"
@classmethod
def translate_bool(cls, val):
return cls.translate_raw_str(val)
@classmethod
def translate_dict(cls, val):
escaped = ', '.join([f"{cls.translate_str(k)}: {cls.translate(v)}" for k, v in val.items()])
return f'{{{escaped}}}'
@classmethod
def translate_list(cls, val):
escaped = ', '.join([cls.translate(v) for v in val])
return f'[{escaped}]'
@classmethod
def comment(cls, cmt_str):
return f'# {cmt_str}'.strip()
@classmethod
def codify(cls, parameters, comment='Parameters'):
content = super().codify(parameters, comment)
try:
# Put content through the Black Python code formatter
import black
fm = black.FileMode(string_normalization=False)
content = black.format_str(content, mode=fm)
except ImportError:
logger.debug("Black is not installed, parameters won't be formatted")
except AttributeError as aerr:
logger.warning(f"Black encountered an error, skipping formatting ({aerr})")
return content
@classmethod
def inspect(cls, parameters_cell):
"""Inspect the parameters cell to get a Parameter list
It must return an empty list if no parameters are found and
it should ignore inspection errors.
Parameters
----------
parameters_cell : NotebookNode
Cell tagged _parameters_
Returns
-------
List[Parameter]
A list of all parameters
"""
params = []
src = parameters_cell['source']
def flatten_accumulator(accumulator):
"""Flatten a multilines variable definition.
Remove all comments except on the latest line - will be interpreted as help.
Args:
accumulator (List[str]): Line composing the variable definition
Returns:
Flatten definition
"""
flat_string = ""
for line in accumulator[:-1]:
if "#" in line:
comment_pos = line.index("#")
flat_string += line[:comment_pos].strip()
else:
flat_string += line.strip()
if len(accumulator):
flat_string += accumulator[-1].strip()
return flat_string
# Some common type like dictionaries or list can be expressed over multiline.
# To support the parsing of such case, the cell lines are grouped between line
# actually containing an assignment. In each group, the commented and empty lines
# are skip; i.e. the parameter help can only be given as comment on the last variable
# line definition
grouped_variable = []
accumulator = []
for iline, line in enumerate(src.splitlines()):
if len(line.strip()) == 0 or line.strip().startswith('#'):
continue # Skip blank and comment
nequal = line.count("=")
if nequal > 0:
grouped_variable.append(flatten_accumulator(accumulator))
accumulator = []
if nequal > 1:
logger.warning(f"Unable to parse line {iline + 1} '{line}'.")
continue
accumulator.append(line)
grouped_variable.append(flatten_accumulator(accumulator))
for definition in grouped_variable:
if len(definition) == 0:
continue
match = re.match(cls.PARAMETER_PATTERN, definition)
if match is not None:
attr = match.groupdict()
if attr["target"] is None: # Fail to get variable name
continue
type_name = str(attr["annotation"] or attr["type_comment"] or None)
params.append(
Parameter(
name=attr["target"].strip(),
inferred_type_name=type_name.strip(),
default=str(attr["value"]).strip(),
help=str(attr["help"] or "").strip(),
)
)
return params
class RTranslator(Translator):
@classmethod
def translate_none(cls, val):
return 'NULL'
@classmethod
def translate_bool(cls, val):
return 'TRUE' if val else 'FALSE'
@classmethod
def translate_dict(cls, val):
escaped = ', '.join([f'{cls.translate_str(k)} = {cls.translate(v)}' for k, v in val.items()])
return f'list({escaped})'
@classmethod
def translate_list(cls, val):
escaped = ', '.join([cls.translate(v) for v in val])
return f'list({escaped})'
@classmethod
def comment(cls, cmt_str):
return f'# {cmt_str}'.strip()
@classmethod
def assign(cls, name, str_val):
# Leading '_' aren't legal R variable names -- so we drop them when injecting
while name.startswith("_"):
name = name[1:]
return f'{name} = {str_val}'
class ScalaTranslator(Translator):
@classmethod
def translate_int(cls, val):
strval = cls.translate_raw_str(val)
return f"{strval}L" if (val > 2147483647 or val < -2147483648) else strval
@classmethod
def translate_dict(cls, val):
"""Translate dicts to scala Maps"""
escaped = ', '.join([f"{cls.translate_str(k)} -> {cls.translate(v)}" for k, v in val.items()])
return f'Map({escaped})'
@classmethod
def translate_list(cls, val):
"""Translate list to scala Seq"""
escaped = ', '.join([cls.translate(v) for v in val])
return f'Seq({escaped})'
@classmethod
def comment(cls, cmt_str):
return f'// {cmt_str}'.strip()
@classmethod
def assign(cls, name, str_val):
return f'val {name} = {str_val}'
class JuliaTranslator(Translator):
@classmethod
def translate_none(cls, val):
return 'nothing'
@classmethod
def translate_dict(cls, val):
escaped = ', '.join([f"{cls.translate_str(k)} => {cls.translate(v)}" for k, v in val.items()])
return f'Dict({escaped})'
@classmethod
def translate_list(cls, val):
escaped = ', '.join([cls.translate(v) for v in val])
return f'[{escaped}]'
@classmethod
def comment(cls, cmt_str):
return f'# {cmt_str}'.strip()
class MatlabTranslator(Translator):
@classmethod
def translate_escaped_str(cls, str_val):
"""Translate a string to an escaped Matlab string"""
if isinstance(str_val, str):
str_val = str_val.encode('unicode_escape')
str_val = str_val.decode('utf-8')
str_val = str_val.replace('"', '""')
return f'"{str_val}"'
@staticmethod
def __translate_char_array(str_val):
"""Translates a string to a Matlab char array"""
if isinstance(str_val, str):
str_val = str_val.encode('unicode_escape')
str_val = str_val.decode('utf-8')
str_val = str_val.replace('\'', '\'\'')
return f'\'{str_val}\''
@classmethod
def translate_none(cls, val):
return 'NaN'
@classmethod
def translate_dict(cls, val):
keys = ', '.join([f"{cls.__translate_char_array(k)}" for k, v in val.items()])
vals = ', '.join([f"{cls.translate(v)}" for k, v in val.items()])
return f'containers.Map({{{keys}}}, {{{vals}}})'
@classmethod
def translate_list(cls, val):
escaped = ', '.join([cls.translate(v) for v in val])
return f'{{{escaped}}}'
@classmethod
def comment(cls, cmt_str):
return f'% {cmt_str}'.strip()
@classmethod
def codify(cls, parameters, comment='Parameters'):
content = f'{cls.comment(comment)}\n'
for name, val in parameters.items():
content += f'{cls.assign(name, cls.translate(val))};\n'
return content
class CSharpTranslator(Translator):
@classmethod
def translate_none(cls, val):
# Can't figure out how to do this as nullable
raise NotImplementedError("Option type not implemented for C#.")
@classmethod
def translate_bool(cls, val):
return 'true' if val else 'false'
@classmethod
def translate_int(cls, val):
strval = cls.translate_raw_str(val)
return f"{strval}L" if (val > 2147483647 or val < -2147483648) else strval
@classmethod
def translate_dict(cls, val):
"""Translate dicts to nontyped dictionary"""
kvps = ', '.join([f"{{ {cls.translate_str(k)} , {cls.translate(v)} }}" for k, v in val.items()])
return f'new Dictionary<string,Object>{{ {kvps} }}'
@classmethod
def translate_list(cls, val):
"""Translate list to array"""
escaped = ', '.join([cls.translate(v) for v in val])
return f'new [] {{ {escaped} }}'
@classmethod
def comment(cls, cmt_str):
return f'// {cmt_str}'.strip()
@classmethod
def assign(cls, name, str_val):
return f'var {name} = {str_val};'
class FSharpTranslator(Translator):
@classmethod
def translate_none(cls, val):
return 'None'
@classmethod
def translate_bool(cls, val):
return 'true' if val else 'false'
@classmethod
def translate_int(cls, val):
strval = cls.translate_raw_str(val)
return f"{strval}L" if (val > 2147483647 or val < -2147483648) else strval
@classmethod
def translate_dict(cls, val):
tuples = '; '.join([f"({cls.translate_str(k)}, {cls.translate(v)} :> IComparable)" for k, v in val.items()])
return f'[ {tuples} ] |> Map.ofList'
@classmethod
def translate_list(cls, val):
escaped = '; '.join([cls.translate(v) for v in val])
return f'[ {escaped} ]'
@classmethod
def comment(cls, cmt_str):
return f'(* {cmt_str} *)'.strip()
@classmethod
def assign(cls, name, str_val):
return f'let {name} = {str_val}'
class PowershellTranslator(Translator):
@classmethod
def translate_escaped_str(cls, str_val):
"""Translate a string to an escaped Matlab string"""
if isinstance(str_val, str):
str_val = str_val.encode('unicode_escape')
str_val = str_val.decode('utf-8')
str_val = str_val.replace('"', '`"')
return f'"{str_val}"'
@classmethod
def translate_float(cls, val):
if math.isfinite(val):
return cls.translate_raw_str(val)
elif math.isnan(val):
return "[double]::NaN"
elif val < 0:
return "[double]::NegativeInfinity"
else:
return "[double]::PositiveInfinity"
@classmethod
def translate_none(cls, val):
return '$Null'
@classmethod
def translate_bool(cls, val):
return '$True' if val else '$False'
@classmethod
def translate_dict(cls, val):
kvps = '\n '.join([f"{cls.translate_str(k)} = {cls.translate(v)}" for k, v in val.items()])
return f'@{{{kvps}}}'
@classmethod
def translate_list(cls, val):
escaped = ', '.join([cls.translate(v) for v in val])
return f'@({escaped})'
@classmethod
def comment(cls, cmt_str):
return f'# {cmt_str}'.strip()
@classmethod
def assign(cls, name, str_val):
return f'${name} = {str_val}'
class BashTranslator(Translator):
@classmethod
def translate_none(cls, val):
return ''
@classmethod
def translate_bool(cls, val):
return 'true' if val else 'false'
@classmethod
def translate_escaped_str(cls, str_val):
return shlex.quote(str(str_val))
@classmethod
def translate_list(cls, val):
escaped = ' '.join([cls.translate(v) for v in val])
return f'({escaped})'
@classmethod
def comment(cls, cmt_str):
return f'# {cmt_str}'.strip()
@classmethod
def assign(cls, name, str_val):
return f'{name}={str_val}'
# Instantiate a PapermillIO instance and register Handlers.
papermill_translators = PapermillTranslators()
papermill_translators.register("python", PythonTranslator)
papermill_translators.register("R", RTranslator)
papermill_translators.register("scala", ScalaTranslator)
papermill_translators.register("julia", JuliaTranslator)
papermill_translators.register("matlab", MatlabTranslator)
papermill_translators.register(".net-csharp", CSharpTranslator)
papermill_translators.register(".net-fsharp", FSharpTranslator)
papermill_translators.register(".net-powershell", PowershellTranslator)
papermill_translators.register("pysparkkernel", PythonTranslator)
papermill_translators.register("sparkkernel", ScalaTranslator)
papermill_translators.register("sparkrkernel", RTranslator)
papermill_translators.register("bash", BashTranslator)
def translate_parameters(kernel_name, language, parameters, comment='Parameters'):
return papermill_translators.find_translator(kernel_name, language).codify(parameters, comment)
|