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
|
import abc
import operator
import re
from datetime import date, datetime
from enum import Enum
from itertools import repeat
from typing import Any, Optional, Union
from pyparsing import (
CaselessKeyword,
Forward,
OpAssoc,
ParserElement,
ParseResults,
QuotedString,
Suppress,
Word,
alphanums,
exceptions,
infix_notation,
one_of,
pyparsing_common,
)
try:
# TODO import directly when depending on pyparsing>=3.1.0
from pyparsing import DelimitedList
except ImportError:
# delimited_list is deprecated in favor of DelimitedList in pyparsing 3.1.0
from pyparsing import delimited_list as DelimitedList # type: ignore[assignment]
from .exceptions import (
InvalidFilterFieldNameException,
InvalidFilterOperatorException,
InvalidInputException,
InvalidLogicalOperatorException,
InvalidStateException,
)
class Logical(str, Enum):
AND = "AND"
ANY = "ANY"
class ConditionState(str, Enum):
SUCCEEDED = "SUCCEEDED"
FAILED = "FAILED"
STOPPED = "STOPPED"
TIMEOUT = "TIMEOUT"
CANCELLED = "CANCELLED"
class CrawlState(str, Enum):
RUNNING = "RUNNING"
CANCELLING = "CANCELLING"
CANCELLED = "CANCELLED"
SUCCEEDED = "SUCCEEDED"
FAILED = "FAILED"
ERROR = "ERROR"
class Condition:
def __init__(self, inputs: dict[str, str], index: int) -> None:
# if there's a job name present, the API creates a job trigger, even if crawler trigger args are provided
self.job_name = inputs.get("JobName")
self.crawler_name = inputs.get("CrawlerName")
self.state: Optional[ConditionState] = None
self.crawl_state: Optional[CrawlState] = None
if self.job_name:
self.crawler_name = None
if inputs.get("State"):
self.state = ConditionState(inputs.get("State"))
else:
raise InvalidInputException(
"CreateTrigger",
"State cannot be null or empty, choose from one of the following job state: [SUCCEEDED, STOPPED, FAILED, TIMEOUT]",
)
elif self.crawler_name:
self.job_name = None
if inputs.get("CrawlState"):
self.crawl_state = CrawlState(inputs.get("CrawlState"))
else:
raise InvalidInputException(
"CreateTrigger",
"State cannot be null or empty, choose from one of the following crawler state: [SUCCEEDED, FAILED, CANCELLED]",
)
else:
raise InvalidInputException(
"CreateTrigger",
"JobName or CrawlerName in condition cannot be null or empty",
)
logical_operator = inputs.get("LogicalOperator")
if logical_operator:
self.logical_operator = logical_operator
else:
raise InvalidInputException(
"CreateTrigger",
"Logical operator cannot be null or empty",
)
if self.logical_operator != "EQUALS":
raise InvalidLogicalOperatorException(self.logical_operator, index + 1)
def as_dict(self) -> dict[str, str]:
return_dict = {
"LogicalOperator": self.logical_operator,
}
if self.crawler_name:
return_dict["CrawlerName"] = self.crawler_name
if self.job_name:
return_dict["JobName"] = self.job_name
if self.crawl_state:
return_dict["CrawlState"] = self.crawl_state.value
if self.state:
return_dict["State"] = self.state.value
return return_dict
class Predicate:
def __init__(self, inputs: dict[str, Any]) -> None:
self.logical = Logical(inputs.get("Logical"))
self.conditions: list[Condition] = [
Condition(condition, index)
for index, condition in enumerate(inputs.get("Conditions", []))
]
def as_dict(self) -> dict[str, Union[str, list[dict[str, str]]]]:
return_dict: dict[str, Union[str, list[dict[str, str]]]] = {}
if self.logical:
return_dict["Logical"] = self.logical.value
if self.conditions:
return_dict["Conditions"] = [
condition.as_dict() for condition in self.conditions
]
return return_dict
class Action:
def __init__(self, inputs: dict[str, Union[str, dict[str, str], int]]) -> None:
self.arguments = inputs.get("Arguments")
self.crawler_name = inputs.get("CrawlerName")
self.job_name = inputs.get("JobName")
self.notification_property = inputs.get("NotificationProperty")
self.security_configuration = inputs.get("SecurityConfiguration")
self.timeout = inputs.get("Timeout")
if self.crawler_name and self.job_name:
raise InvalidInputException(
"CreateTrigger",
"Both JobName and CrawlerName cannot be set together in an action",
)
def as_dict(self) -> dict[str, Union[str, dict[str, str], int]]:
return_dict: dict[str, Union[str, dict[str, str], int]] = {}
if self.arguments:
return_dict["Arguments"] = self.arguments
if self.crawler_name:
return_dict["CrawlerName"] = self.crawler_name
if self.job_name:
return_dict["JobName"] = self.job_name
if self.notification_property:
return_dict["NotificationProperty"] = self.notification_property
if self.security_configuration:
return_dict["SecurityConfiguration"] = self.security_configuration
if self.timeout is not None:
return_dict["Timeout"] = self.timeout
return return_dict
class FilterField(str, Enum):
CRAWL_ID = "CRAWL_ID"
STATE = "STATE"
START_TIME = "START_TIME"
END_TIME = "END_TIME"
DPU_HOUR = "DPU_HOUR"
class FilterOperator(str, Enum):
GT = "GT"
GE = "GE"
LT = "LT"
LE = "LE"
EQ = "EQ"
NE = "NE"
class CrawlFilter:
def __init__(
self, field_name: FilterField, operator: FilterOperator, field_value: str
) -> None:
self.field_name = field_name
self.field_value = field_value
self.operator = operator
self.check_operator_valid_for_state()
def check_operator_valid_for_state(self) -> None:
if self.field_name in [FilterField.STATE, FilterField.CRAWL_ID]:
if self.operator not in [FilterOperator.EQ, FilterOperator.NE]:
raise InvalidInputException(
"ListCrawls",
f"Only EQ or NE operator is allowed for field : {self.field_name.value}",
)
def validate_crawl_filters(filters: list[dict[str, str]]) -> list[CrawlFilter]:
filter_objects: list[CrawlFilter] = []
for index, filter in enumerate(filters):
field_name_input = filter.get("FieldName")
operator_input = filter.get("FilterOperator")
field_value_input = filter.get("FieldValue")
if not all([field_name_input, field_value_input, operator_input]):
raise InvalidInputException(
"ListCrawls",
f"Invalid Filter Provided: FieldName: {field_name_input if field_name_input else 'null'}, "
f"FilterOperator: {operator_input if operator_input else 'null'}, "
f"FieldValue: {field_value_input if field_value_input else 'null'}",
)
try:
field_name = FilterField(field_name_input)
except ValueError:
raise InvalidFilterFieldNameException(filter["FieldName"], index + 1)
try:
operator = FilterOperator(operator_input)
except ValueError:
raise InvalidFilterOperatorException(filter["FilterOperator"], index + 1)
filter_objects.append(CrawlFilter(field_name, operator, filter["FieldValue"]))
return filter_objects
def _cast(type_: str, value: Any) -> Union[date, datetime, float, int, str]:
# values are always cast from string to target type
value = str(value)
if type_ in ("bigint", "int", "smallint", "tinyint"):
try:
return int(value) # no size is enforced
except ValueError:
raise ValueError(f'"{value}" is not an integer.')
if type_ == "decimal":
try:
return float(value)
except ValueError:
raise ValueError(f"{value} is not a decimal.")
if type_ in ("char", "string", "varchar"):
return value # no length is enforced
if type_ == "date":
try:
return datetime.strptime(value, "%Y-%m-%d").date()
except ValueError:
raise ValueError(f"{value} is not a date.")
if type_ == "timestamp":
match = re.search(
r"^(?P<timestamp>\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})"
r"(?P<nanos>\.\d{1,9})?$",
value,
)
if match is None:
raise ValueError(
"Timestamp format must be yyyy-mm-dd hh:mm:ss[.fffffffff]"
f" {value} is not a timestamp."
)
try:
timestamp = datetime.strptime(match.group("timestamp"), "%Y-%m-%d %H:%M:%S")
except ValueError:
raise ValueError(
"Timestamp format must be yyyy-mm-dd hh:mm:ss[.fffffffff]"
f" {value} is not a timestamp."
)
# use nanosecond representation for timestamps
posix_nanoseconds = int(timestamp.timestamp() * 1_000_000_000)
nanos = match.group("nanos")
if nanos is not None:
# strip leading dot, reverse and left pad with zeros to nanoseconds
nanos = "".join(reversed(nanos[1:])).zfill(9)
for i, nanoseconds in enumerate(nanos):
posix_nanoseconds += int(nanoseconds) * 10**i
return posix_nanoseconds
raise InvalidInputException("GetPartitions", f"Unknown type : '{type_}'")
def _escape_regex(pattern: str) -> str:
"""Taken from Python 3.7 to avoid escaping '%'."""
_special_chars_map = {i: "\\" + chr(i) for i in b"()[]{}?*+-|^$\\.&~# \t\n\r\v\f"}
return pattern.translate(_special_chars_map)
class _Expr(abc.ABC):
@abc.abstractmethod
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> Any: # type: ignore[misc]
raise NotImplementedError()
class _Ident(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: str = tokens[0]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> Any:
try:
return self._eval(part_keys, part_input)
except ValueError as e:
# existing partition values cannot be cast to current schema
raise InvalidStateException("GetPartitions", str(e))
def leval(self, part_keys: list[dict[str, str]], literal: Any) -> Any:
# evaluate literal by simulating partition input
try:
return self._eval(part_keys, part_input={"Values": repeat(literal)})
except ValueError as e:
# expression literal cannot be cast to current schema
raise InvalidInputException("GetPartitions", str(e))
def type_(self, part_keys: list[dict[str, str]]) -> str:
for key in part_keys:
if self.ident == key["Name"]:
return key["Type"]
# not a partition column
raise InvalidInputException("GetPartitions", "Invalid partition expression!")
def _eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> Any:
for key, value in zip(part_keys, part_input["Values"]):
if self.ident == key["Name"]:
return _cast(key["Type"], value)
# also raised for unpartitioned tables
raise InvalidInputException("GetPartitions", "Invalid partition expression!")
class _IsNull(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: _Ident = tokens[0]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return self.ident.eval(part_keys, part_input) is None
class _IsNotNull(_IsNull):
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return not super().eval(part_keys, part_input)
class _BinOp(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: _Ident = tokens[0]
self.bin_op: str = tokens[1]
self.literal: Any = tokens[2]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
ident = self.ident.eval(part_keys, part_input)
# simulate partition input for the lateral
rhs = self.ident.leval(part_keys, self.literal)
return {
"<>": operator.ne,
">=": operator.ge,
"<=": operator.le,
">": operator.gt,
"<": operator.lt,
"=": operator.eq,
}[self.bin_op](ident, rhs)
class _Like(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: _Ident = tokens[0]
self.literal: str = tokens[2]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
type_ = self.ident.type_(part_keys)
if type_ in ("bigint", "int", "smallint", "tinyint"):
raise InvalidInputException(
"GetPartitions", "Integral data type doesn't support operation 'LIKE'"
)
if type_ in ("date", "decimal", "timestamp"):
raise InvalidInputException(
"GetPartitions",
f"{type_[0].upper()}{type_[1:]} data type"
" doesn't support operation 'LIKE'",
)
ident = self.ident.eval(part_keys, part_input)
assert isinstance(ident, str)
pattern = _cast("string", self.literal)
# prepare SQL pattern for conversion to regex pattern
pattern = _escape_regex(pattern) # type: ignore
# NOTE convert SQL wildcards to regex, no literal matches possible
pattern = pattern.replace("_", ".").replace("%", ".*")
# LIKE clauses always start at the beginning
pattern = "^" + pattern + "$"
return re.search(pattern, ident) is not None
class _NotLike(_Like):
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return not super().eval(part_keys, part_input)
class _In(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: _Ident = tokens[0]
self.values: list[Any] = tokens[2:]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
ident = self.ident.eval(part_keys, part_input)
values = (self.ident.leval(part_keys, value) for value in self.values)
return ident in values
class _NotIn(_In):
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return not super().eval(part_keys, part_input)
class _Between(_Expr):
def __init__(self, tokens: ParseResults):
self.ident: _Ident = tokens[0]
self.left: Any = tokens[2]
self.right: Any = tokens[4]
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
ident = self.ident.eval(part_keys, part_input)
left = self.ident.leval(part_keys, self.left)
right = self.ident.leval(part_keys, self.right)
return left <= ident <= right or left > ident > right
class _NotBetween(_Between):
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return not super().eval(part_keys, part_input)
class _BoolAnd(_Expr):
def __init__(self, tokens: ParseResults) -> None:
self.operands: list[_Expr] = tokens[0][0::2] # skip 'and' between tokens
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return all(operand.eval(part_keys, part_input) for operand in self.operands)
class _BoolOr(_Expr):
def __init__(self, tokens: ParseResults) -> None:
self.operands: list[_Expr] = tokens[0][0::2] # skip 'or' between tokens
def eval(self, part_keys: list[dict[str, str]], part_input: dict[str, Any]) -> bool:
return any(operand.eval(part_keys, part_input) for operand in self.operands)
class _PartitionFilterExpressionCache:
def __init__(self) -> None:
# build grammar according to Glue.Client.get_partitions(Expression)
lpar, rpar = map(Suppress, "()")
# NOTE these are AWS Athena column name best practices
ident = Forward().set_name("ident")
ident <<= Word(alphanums + "._").set_parse_action(_Ident) | lpar + ident + rpar # type: ignore
number = Forward().set_name("number")
number <<= pyparsing_common.number | lpar + number + rpar # type: ignore
string = Forward().set_name("string")
string <<= QuotedString(quote_char="'", esc_quote="''") | lpar + string + rpar # type: ignore
literal = (number | string).set_name("literal")
literal_list = DelimitedList(literal, min=1).set_name("list")
bin_op = one_of("<> >= <= > < =").set_name("binary op")
and_ = Forward()
and_ <<= CaselessKeyword("and") | lpar + and_ + rpar
or_ = Forward()
or_ <<= CaselessKeyword("or") | lpar + or_ + rpar
in_, between, like, not_, is_, null = map(
CaselessKeyword, "in between like not is null".split()
)
not_ = Suppress(not_) # type: ignore # only needed for matching
cond = (
(ident + is_ + null).set_parse_action(_IsNull)
| (ident + is_ + not_ + null).set_parse_action(_IsNotNull)
| (ident + bin_op + literal).set_parse_action(_BinOp)
| (ident + like + string).set_parse_action(_Like)
| (ident + not_ + like + string).set_parse_action(_NotLike)
| (ident + in_ + lpar + literal_list + rpar).set_parse_action(_In)
| (ident + not_ + in_ + lpar + literal_list + rpar).set_parse_action(_NotIn)
| (ident + between + literal + and_ + literal).set_parse_action(_Between)
| (ident + not_ + between + literal + and_ + literal).set_parse_action(
_NotBetween
)
).set_name("cond")
# conditions can be joined using 2-ary AND and/or OR
expr = infix_notation(
cond,
[
(and_, 2, OpAssoc.LEFT, _BoolAnd),
(or_, 2, OpAssoc.LEFT, _BoolOr),
],
)
self._expr = expr.set_name("expr")
self._cache: dict[str, _Expr] = {}
def get(self, expression: Optional[str]) -> Optional[_Expr]:
if expression is None:
return None
if expression not in self._cache:
ParserElement.enable_packrat()
try:
expr: ParseResults = self._expr.parse_string(expression, parse_all=True)
self._cache[expression] = expr[0]
except exceptions.ParseException:
raise InvalidInputException(
"GetPartitions", f"Unsupported expression '{expression}'"
)
return self._cache[expression]
_PARTITION_FILTER_EXPRESSION_CACHE = _PartitionFilterExpressionCache()
class PartitionFilter:
def __init__(self, expression: Optional[str], fake_table: Any):
self.expression = expression
self.fake_table = fake_table
def __call__(self, fake_partition: Any) -> bool:
expression = _PARTITION_FILTER_EXPRESSION_CACHE.get(self.expression)
if expression is None:
return True
versions = list(self.fake_table.versions.values())
return expression.eval(
part_keys=versions[-1].get("PartitionKeys", []),
part_input=fake_partition.partition_input,
)
|