czekitout

czekitout is a Python library that contains a collection of functions that facilitate type-checking, validation, and type-conversions, with useful error messages when exceptions are thrown.

Setting up czekitout

For instructions on installing the czekitout library, see the Installation instructions page.

Learning how to use czekitout

For those new to the czekitout library, it is recommended that they take a look at the Examples page, which contains some code examples that show how one can use the czekitout library. While going through the examples, readers can consult the czekitout reference guide to understand what each line of code is doing in each example.

Contents

• home
• 1. Installation instructions
  • 1.1. Installing czekitout
    • 1.1.1. Installing czekitout using pip
    • 1.1.2. Installing czekitout using conda
  • 1.2. Uninstalling czekitout
• 2. Reference
  • 2.1. czekitout.check
    • 2.1.1. czekitout.check.if_bool
      • if_bool()
    • 2.1.2. czekitout.check.if_bool_array_3d
      • if_bool_array_3d()
    • 2.1.3. czekitout.check.if_bool_matrix
      • if_bool_matrix()
    • 2.1.4. czekitout.check.if_bool_seq
      • if_bool_seq()
    • 2.1.5. czekitout.check.if_callable
      • if_callable()
    • 2.1.6. czekitout.check.if_complex_numpy_array
      • if_complex_numpy_array()
    • 2.1.7. czekitout.check.if_complex_numpy_matrix
      • if_complex_numpy_matrix()
    • 2.1.8. czekitout.check.if_dict_like
      • if_dict_like()
    • 2.1.9. czekitout.check.if_float
      • if_float()
    • 2.1.10. czekitout.check.if_float_seq
      • if_float_seq()
    • 2.1.11. czekitout.check.if_instance_of_any_accepted_types
      • if_instance_of_any_accepted_types()
    • 2.1.12. czekitout.check.if_int
      • if_int()
    • 2.1.13. czekitout.check.if_int_seq
      • if_int_seq()
    • 2.1.14. czekitout.check.if_multi_dim_slice_like
      • if_multi_dim_slice_like()
    • 2.1.15. czekitout.check.if_nonnegative_float
      • if_nonnegative_float()
    • 2.1.16. czekitout.check.if_nonnegative_float_seq
      • if_nonnegative_float_seq()
    • 2.1.17. czekitout.check.if_nonnegative_int
      • if_nonnegative_int()
    • 2.1.18. czekitout.check.if_nonnegative_int_seq
      • if_nonnegative_int_seq()
    • 2.1.19. czekitout.check.if_nonnegative_numpy_array
      • if_nonnegative_numpy_array()
    • 2.1.20. czekitout.check.if_nonnegative_numpy_matrix
      • if_nonnegative_numpy_matrix()
    • 2.1.21. czekitout.check.if_one_of_any_accepted_strings
      • if_one_of_any_accepted_strings()
    • 2.1.22. czekitout.check.if_pair_of_floats
      • if_pair_of_floats()
    • 2.1.23. czekitout.check.if_pair_of_ints
      • if_pair_of_ints()
    • 2.1.24. czekitout.check.if_pair_of_nonnegative_floats
      • if_pair_of_nonnegative_floats()
    • 2.1.25. czekitout.check.if_pair_of_nonnegative_ints
      • if_pair_of_nonnegative_ints()
    • 2.1.26. czekitout.check.if_pair_of_positive_floats
      • if_pair_of_positive_floats()
    • 2.1.27. czekitout.check.if_pair_of_positive_ints
      • if_pair_of_positive_ints()
    • 2.1.28. czekitout.check.if_pairs_of_floats
      • if_pairs_of_floats()
    • 2.1.29. czekitout.check.if_pairs_of_ints
      • if_pairs_of_ints()
    • 2.1.30. czekitout.check.if_pairs_of_nonnegative_ints
      • if_pairs_of_nonnegative_ints()
    • 2.1.31. czekitout.check.if_positive_float
      • if_positive_float()
    • 2.1.32. czekitout.check.if_positive_float_seq
      • if_positive_float_seq()
    • 2.1.33. czekitout.check.if_positive_int
      • if_positive_int()
    • 2.1.34. czekitout.check.if_positive_int_seq
      • if_positive_int_seq()
    • 2.1.35. czekitout.check.if_quadruplet_of_nonnegative_ints
      • if_quadruplet_of_nonnegative_ints()
    • 2.1.36. czekitout.check.if_real_numpy_array
      • if_real_numpy_array()
    • 2.1.37. czekitout.check.if_real_numpy_array_1d
      • if_real_numpy_array_1d()
    • 2.1.38. czekitout.check.if_real_numpy_array_3d
      • if_real_numpy_array_3d()
    • 2.1.39. czekitout.check.if_real_numpy_matrix
      • if_real_numpy_matrix()
    • 2.1.40. czekitout.check.if_real_two_column_numpy_matrix
      • if_real_two_column_numpy_matrix()
    • 2.1.41. czekitout.check.if_scalar
      • if_scalar()
    • 2.1.42. czekitout.check.if_single_dim_slice_like
      • if_single_dim_slice_like()
    • 2.1.43. czekitout.check.if_str_like
      • if_str_like()
    • 2.1.44. czekitout.check.if_str_like_seq
      • if_str_like_seq()
  • 2.2. czekitout.convert
    • 2.2.1. czekitout.convert.to_bool
      • to_bool()
    • 2.2.2. czekitout.convert.to_bool_numpy_array_3d
      • to_bool_numpy_array_3d()
    • 2.2.3. czekitout.convert.to_bool_numpy_matrix
      • to_bool_numpy_matrix()
    • 2.2.4. czekitout.convert.to_complex_numpy_array
      • to_complex_numpy_array()
    • 2.2.5. czekitout.convert.to_complex_numpy_matrix
      • to_complex_numpy_matrix()
    • 2.2.6. czekitout.convert.to_dict
      • to_dict()
    • 2.2.7. czekitout.convert.to_float
      • to_float()
    • 2.2.8. czekitout.convert.to_int
      • to_int()
    • 2.2.9. czekitout.convert.to_list_of_bools
      • to_list_of_bools()
    • 2.2.10. czekitout.convert.to_list_of_floats
      • to_list_of_floats()
    • 2.2.11. czekitout.convert.to_list_of_ints
      • to_list_of_ints()
    • 2.2.12. czekitout.convert.to_list_of_nonnegative_floats
      • to_list_of_nonnegative_floats()
    • 2.2.13. czekitout.convert.to_list_of_nonnegative_ints
      • to_list_of_nonnegative_ints()
    • 2.2.14. czekitout.convert.to_list_of_positive_floats
      • to_list_of_positive_floats()
    • 2.2.15. czekitout.convert.to_list_of_positive_ints
      • to_list_of_positive_ints()
    • 2.2.16. czekitout.convert.to_list_of_strs
      • to_list_of_strs()
    • 2.2.17. czekitout.convert.to_multi_dim_slice
      • to_multi_dim_slice()
    • 2.2.18. czekitout.convert.to_nonnegative_float
      • to_nonnegative_float()
    • 2.2.19. czekitout.convert.to_nonnegative_int
      • to_nonnegative_int()
    • 2.2.20. czekitout.convert.to_nonnegative_numpy_array
      • to_nonnegative_numpy_array()
    • 2.2.21. czekitout.convert.to_nonnegative_numpy_matrix
      • to_nonnegative_numpy_matrix()
    • 2.2.22. czekitout.convert.to_numpy_array
      • to_numpy_array()
    • 2.2.23. czekitout.convert.to_pair_of_floats
      • to_pair_of_floats()
    • 2.2.24. czekitout.convert.to_pair_of_ints
      • to_pair_of_ints()
    • 2.2.25. czekitout.convert.to_pair_of_nonnegative_floats
      • to_pair_of_nonnegative_floats()
    • 2.2.26. czekitout.convert.to_pair_of_nonnegative_ints
      • to_pair_of_nonnegative_ints()
    • 2.2.27. czekitout.convert.to_pair_of_positive_floats
      • to_pair_of_positive_floats()
    • 2.2.28. czekitout.convert.to_pair_of_positive_ints
      • to_pair_of_positive_ints()
    • 2.2.29. czekitout.convert.to_pairs_of_floats
      • to_pairs_of_floats()
    • 2.2.30. czekitout.convert.to_pairs_of_ints
      • to_pairs_of_ints()
    • 2.2.31. czekitout.convert.to_pairs_of_nonnegative_ints
      • to_pairs_of_nonnegative_ints()
    • 2.2.32. czekitout.convert.to_positive_float
      • to_positive_float()
    • 2.2.33. czekitout.convert.to_positive_int
      • to_positive_int()
    • 2.2.34. czekitout.convert.to_quadruplet_of_nonnegative_ints
      • to_quadruplet_of_nonnegative_ints()
    • 2.2.35. czekitout.convert.to_real_numpy_array
      • to_real_numpy_array()
    • 2.2.36. czekitout.convert.to_real_numpy_array_1d
      • to_real_numpy_array_1d()
    • 2.2.37. czekitout.convert.to_real_numpy_array_3d
      • to_real_numpy_array_3d()
    • 2.2.38. czekitout.convert.to_real_numpy_matrix
      • to_real_numpy_matrix()
    • 2.2.39. czekitout.convert.to_real_two_column_numpy_matrix
      • to_real_two_column_numpy_matrix()
    • 2.2.40. czekitout.convert.to_single_dim_slice
      • to_single_dim_slice()
    • 2.2.41. czekitout.convert.to_str_from_str_like
      • to_str_from_str_like()
    • 2.2.42. czekitout.convert.to_tuple_of_bools
      • to_tuple_of_bools()
    • 2.2.43. czekitout.convert.to_tuple_of_floats
      • to_tuple_of_floats()
    • 2.2.44. czekitout.convert.to_tuple_of_ints
      • to_tuple_of_ints()
    • 2.2.45. czekitout.convert.to_tuple_of_nonnegative_floats
      • to_tuple_of_nonnegative_floats()
    • 2.2.46. czekitout.convert.to_tuple_of_nonnegative_ints
      • to_tuple_of_nonnegative_ints()
    • 2.2.47. czekitout.convert.to_tuple_of_positive_floats
      • to_tuple_of_positive_floats()
    • 2.2.48. czekitout.convert.to_tuple_of_positive_ints
      • to_tuple_of_positive_ints()
    • 2.2.49. czekitout.convert.to_tuple_of_strs
      • to_tuple_of_strs()
  • 2.3. czekitout.isa
    • 2.3.1. czekitout.isa.bool_numpy_array
      • bool_numpy_array()
    • 2.3.2. czekitout.isa.bool_numpy_array_3d
      • bool_numpy_array_3d()
    • 2.3.3. czekitout.isa.bool_numpy_matrix
      • bool_numpy_matrix()
    • 2.3.4. czekitout.isa.complex_numpy_array
      • complex_numpy_array()
    • 2.3.5. czekitout.isa.complex_numpy_matrix
      • complex_numpy_matrix()
    • 2.3.6. czekitout.isa.nonnegative_numpy_array
      • nonnegative_numpy_array()
    • 2.3.7. czekitout.isa.nonnegative_numpy_matrix
      • nonnegative_numpy_matrix()
    • 2.3.8. czekitout.isa.numpy_array
      • numpy_array()
    • 2.3.9. czekitout.isa.numpy_array_1d
      • numpy_array_1d()
    • 2.3.10. czekitout.isa.numpy_array_3d
      • numpy_array_3d()
    • 2.3.11. czekitout.isa.numpy_matrix
      • numpy_matrix()
    • 2.3.12. czekitout.isa.real_numpy_array
      • real_numpy_array()
    • 2.3.13. czekitout.isa.real_numpy_array_1d
      • real_numpy_array_1d()
    • 2.3.14. czekitout.isa.real_numpy_array_3d
      • real_numpy_array_3d()
    • 2.3.15. czekitout.isa.real_numpy_matrix
      • real_numpy_matrix()
    • 2.3.16. czekitout.isa.real_two_column_numpy_matrix
      • real_two_column_numpy_matrix()
    • 2.3.17. czekitout.isa.scalar_numpy_array
      • scalar_numpy_array()
    • 2.3.18. czekitout.isa.two_column_numpy_matrix
      • two_column_numpy_matrix()
  • 2.4. czekitout.name
    • 2.4.1. czekitout.name.fully_qualified_class_name
      • fully_qualified_class_name()
  • 2.5. czekitout.version
• 3. Examples
• 4. License

Indices and tables

• Index

• Module Index

• Search Page