apache_beam.typehints package

A package defining the syntax and decorator semantics for type-hints.

Subpackages

• apache_beam.typehints.testing package
  • Submodules
    • apache_beam.typehints.testing.strategies module
      • field_names()
      • types()
      • named_fields()

Submodules

• apache_beam.typehints.arrow_batching_microbenchmark module
  • benchmark_produce_batch()
  • run_benchmark()
• apache_beam.typehints.arrow_type_compatibility module
• apache_beam.typehints.batch module
  • BatchConverter
    • BatchConverter.produce_batch()
    • BatchConverter.explode_batch()
    • BatchConverter.combine_batches()
    • BatchConverter.get_length()
    • BatchConverter.estimate_byte_size()
    • BatchConverter.register()
    • BatchConverter.from_typehints()
    • BatchConverter.batch_type
    • BatchConverter.element_type
• apache_beam.typehints.decorators module
  • disable_type_annotations()
  • no_annotations()
  • with_input_types()
  • with_output_types()
  • WithTypeHints
    • WithTypeHints.get_type_hints()
    • WithTypeHints.default_type_hints()
    • WithTypeHints.with_input_types()
    • WithTypeHints.with_output_types()
  • TypeCheckError
• apache_beam.typehints.intrinsic_one_ops module
  • intrinsic_1_invalid()
  • intrinsic_print()
  • intrinsic_import_star()
  • intrinsic_stopiteration_error()
  • intrinsic_async_gen_wrap()
  • intrinsic_unary_positive()
  • intrinsic_list_to_tuple()
  • intrinsic_typevar()
  • intrinsic_paramspec()
  • intrinsic_typevartuple()
  • intrinsic_subscript_generic()
  • intrinsic_typealias()
• apache_beam.typehints.native_type_compatibility module
  • match_is_named_tuple()
  • extract_optional_type()
  • is_any()
  • is_new_type()
  • is_forward_ref()
  • convert_builtin_to_typing()
  • convert_typing_to_builtin()
  • convert_collections_to_typing()
  • is_builtin()
  • convert_to_beam_type()
  • convert_to_beam_types()
  • convert_to_python_type()
  • convert_to_python_types()
• apache_beam.typehints.opcodes module
  • pop_one()
  • pop_two()
  • pop_three()
  • push_value()
  • nop()
  • resume()
  • pop_top()
  • end_for()
  • end_send()
  • copy()
  • rot_n()
  • rot_two()
  • rot_three()
  • rot_four()
  • dup_top()
  • unary()
  • unary_positive()
  • unary_negative()
  • unary_invert()
  • unary_not()
  • unary_convert()
  • get_iter()
  • symmetric_binary_op()
  • binary_power()
  • inplace_power()
  • binary_multiply()
  • inplace_multiply()
  • binary_divide()
  • inplace_divide()
  • binary_floor_divide()
  • inplace_floor_divide()
  • binary_true_divide()
  • inplace_true_divide()
  • binary_modulo()
  • inplace_modulo()
  • binary_add()
  • inplace_add()
  • binary_subtract()
  • inplace_subtract()
  • binary_subscr()
  • binary_lshift()
  • inplace_lshift()
  • binary_rshift()
  • inplace_rshift()
  • binary_and()
  • inplace_and()
  • binary_xor()
  • inplace_xor()
  • binary_or()
  • inplace_or()
  • binary_op()
  • store_subscr()
  • binary_slice()
  • store_slice()
  • print_item()
  • print_newline()
  • list_append()
  • set_add()
  • map_add()
  • load_locals()
  • exec_stmt()
  • build_class()
  • unpack_sequence()
  • dup_topx()
  • store_attr()
  • delete_attr()
  • store_global()
  • delete_global()
  • load_const()
  • load_name()
  • build_tuple()
  • build_list()
  • build_set()
  • build_map()
  • build_const_key_map()
  • list_to_tuple()
  • build_string()
  • list_extend()
  • set_update()
  • dict_update()
  • dict_merge()
  • load_attr()
  • load_method()
  • compare_op()
  • is_op()
  • contains_op()
  • import_name()
  • import_from()
  • load_global()
  • store_map()
  • load_fast()
  • load_fast_check()
  • load_fast_and_clear()
  • store_fast()
  • delete_fast()
  • swap()
  • reraise()
  • gen_start()
  • load_closure()
  • load_deref()
  • make_function()
  • make_closure()
  • build_slice()
  • format_value()
  • format_simple()
  • format_with_spec()
  • build_list_unpack()
  • build_set_unpack()
  • build_tuple_unpack()
  • build_tuple_unpack_with_call()
  • build_map_unpack()
• apache_beam.typehints.pandas_type_compatibility module
• apache_beam.typehints.pytorch_type_compatibility module
  • PytorchBatchConverter
    • PytorchBatchConverter.from_typehints()
    • PytorchBatchConverter.produce_batch()
    • PytorchBatchConverter.explode_batch()
    • PytorchBatchConverter.combine_batches()
    • PytorchBatchConverter.get_length()
    • PytorchBatchConverter.estimate_byte_size()
  • PytorchTypeHint
    • PytorchTypeHint.PytorchTypeConstraint
      • PytorchTypeHint.PytorchTypeConstraint.type_check()
• apache_beam.typehints.row_type module
  • RowTypeConstraint
    • RowTypeConstraint.from_user_type()
    • RowTypeConstraint.from_fields()
    • RowTypeConstraint.user_type
    • RowTypeConstraint.set_schema_id()
    • RowTypeConstraint.schema_id
    • RowTypeConstraint.schema_options
    • RowTypeConstraint.field_options()
    • RowTypeConstraint.type_check()
    • RowTypeConstraint.get_type_for()
  • GeneratedClassRowTypeConstraint
• apache_beam.typehints.schema_registry module
  • SchemaTypeRegistry
    • SchemaTypeRegistry.generate_new_id()
    • SchemaTypeRegistry.add()
    • SchemaTypeRegistry.get_typing_by_id()
    • SchemaTypeRegistry.get_schema_by_id()
• apache_beam.typehints.schemas module
  • named_fields_to_schema()
  • named_fields_from_schema()
  • typing_to_runner_api()
  • typing_from_runner_api()
  • value_to_runner_api()
  • value_from_runner_api()
  • option_to_runner_api()
  • option_from_runner_api()
  • schema_field()
  • SchemaTranslation
    • SchemaTranslation.typing_to_runner_api()
    • SchemaTranslation.atomic_value_from_runner_api()
    • SchemaTranslation.atomic_value_to_runner_api()
    • SchemaTranslation.value_from_runner_api()
    • SchemaTranslation.value_to_runner_api()
    • SchemaTranslation.option_from_runner_api()
    • SchemaTranslation.option_to_runner_api()
    • SchemaTranslation.typing_from_runner_api()
    • SchemaTranslation.named_tuple_from_schema()
  • named_tuple_from_schema()
  • named_tuple_to_schema()
  • schema_from_element_type()
  • named_fields_from_element_type()
  • union_schema_type()
  • LogicalTypeRegistry
    • LogicalTypeRegistry.add()
    • LogicalTypeRegistry.get_logical_type_by_urn()
    • LogicalTypeRegistry.get_urn_by_logial_type()
    • LogicalTypeRegistry.get_logical_type_by_language_type()
    • LogicalTypeRegistry.copy()
  • LogicalType
    • LogicalType.urn()
    • LogicalType.language_type()
    • LogicalType.representation_type()
    • LogicalType.argument_type()
    • LogicalType.argument()
    • LogicalType.to_representation_type()
    • LogicalType.to_language_type()
    • LogicalType.register_logical_type()
    • LogicalType.from_typing()
    • LogicalType.from_runner_api()
  • NoArgumentLogicalType
    • NoArgumentLogicalType.argument_type()
    • NoArgumentLogicalType.argument()
  • PassThroughLogicalType
    • PassThroughLogicalType.to_language_type()
    • PassThroughLogicalType.representation_type()
    • PassThroughLogicalType.to_representation_type()
  • MicrosInstantRepresentation
    • MicrosInstantRepresentation.micros
    • MicrosInstantRepresentation.seconds
  • MillisInstant
    • MillisInstant.representation_type()
    • MillisInstant.urn()
    • MillisInstant.language_type()
    • MillisInstant.to_language_type()
  • MicrosInstant
    • MicrosInstant.urn()
    • MicrosInstant.representation_type()
    • MicrosInstant.language_type()
    • MicrosInstant.to_representation_type()
    • MicrosInstant.to_language_type()
  • PythonCallable
    • PythonCallable.urn()
    • PythonCallable.representation_type()
    • PythonCallable.language_type()
    • PythonCallable.to_representation_type()
    • PythonCallable.to_language_type()
  • FixedPrecisionDecimalArgumentRepresentation
    • FixedPrecisionDecimalArgumentRepresentation.precision
    • FixedPrecisionDecimalArgumentRepresentation.scale
  • DecimalLogicalType
    • DecimalLogicalType.urn()
    • DecimalLogicalType.representation_type()
    • DecimalLogicalType.language_type()
    • DecimalLogicalType.to_representation_type()
    • DecimalLogicalType.to_language_type()
  • FixedPrecisionDecimalLogicalType
    • FixedPrecisionDecimalLogicalType.urn()
    • FixedPrecisionDecimalLogicalType.representation_type()
    • FixedPrecisionDecimalLogicalType.language_type()
    • FixedPrecisionDecimalLogicalType.to_representation_type()
    • FixedPrecisionDecimalLogicalType.to_language_type()
    • FixedPrecisionDecimalLogicalType.argument_type()
    • FixedPrecisionDecimalLogicalType.argument()
  • FixedBytes
    • FixedBytes.urn()
    • FixedBytes.language_type()
    • FixedBytes.to_language_type()
    • FixedBytes.argument_type()
    • FixedBytes.argument()
  • VariableBytes
    • VariableBytes.urn()
    • VariableBytes.language_type()
    • VariableBytes.to_language_type()
    • VariableBytes.argument_type()
    • VariableBytes.argument()
  • FixedString
    • FixedString.urn()
    • FixedString.language_type()
    • FixedString.to_language_type()
    • FixedString.argument_type()
    • FixedString.argument()
  • VariableString
    • VariableString.urn()
    • VariableString.language_type()
    • VariableString.to_language_type()
    • VariableString.argument_type()
    • VariableString.argument()
• apache_beam.typehints.sharded_key_type module
  • ShardedKeyTypeConstraint
    • ShardedKeyTypeConstraint.type_check()
    • ShardedKeyTypeConstraint.match_type_variables()
  • ShardedKeyType
• apache_beam.typehints.trivial_inference module
  • TypeInferenceError
  • instance_to_type()
  • union_list()
  • Const
    • Const.unwrap()
    • Const.unwrap_all()
  • FrameState
    • FrameState.copy()
    • FrameState.const_type()
    • FrameState.get_closure()
    • FrameState.closure_type()
    • FrameState.get_global()
    • FrameState.get_name()
  • union()
  • finalize_hints()
  • element_type()
  • key_value_types()
  • BoundMethod
  • hashable()
  • infer_return_type()
  • infer_return_type_func()
• apache_beam.typehints.typecheck module
  • AbstractDoFnWrapper
    • AbstractDoFnWrapper.wrapper()
    • AbstractDoFnWrapper.setup()
    • AbstractDoFnWrapper.start_bundle()
    • AbstractDoFnWrapper.process()
    • AbstractDoFnWrapper.finish_bundle()
    • AbstractDoFnWrapper.teardown()
  • OutputCheckWrapperDoFn
    • OutputCheckWrapperDoFn.wrapper()
  • TypeCheckWrapperDoFn
    • TypeCheckWrapperDoFn.wrapper()
    • TypeCheckWrapperDoFn.process()
    • TypeCheckWrapperDoFn.type_check()
  • TypeCheckCombineFn
    • TypeCheckCombineFn.setup()
    • TypeCheckCombineFn.create_accumulator()
    • TypeCheckCombineFn.add_input()
    • TypeCheckCombineFn.merge_accumulators()
    • TypeCheckCombineFn.compact()
    • TypeCheckCombineFn.extract_output()
    • TypeCheckCombineFn.teardown()
  • TypeCheckVisitor
    • TypeCheckVisitor.enter_composite_transform()
    • TypeCheckVisitor.leave_composite_transform()
    • TypeCheckVisitor.visit_transform()
  • PerformanceTypeCheckVisitor
    • PerformanceTypeCheckVisitor.visit_transform()
    • PerformanceTypeCheckVisitor.get_input_type_hints()
    • PerformanceTypeCheckVisitor.get_output_type_hints()
• apache_beam.typehints.typehints module
  • WindowedValue
  • TypeVariable
    • TypeVariable.match_type_variables()
    • TypeVariable.bind_type_variables()