Upgrading¶

From v2.x.x to v3.0.0¶

There were several breaking changes in v3.0.0:

• Make to_string convert None to empty string. (breaking change)
• Make the following functions work with empty strings and None: (breaking change)
  • camel_case
  • capitalize
  • chars
  • chop
  • chop_right
  • class_case
  • clean
  • count_substr
  • decapitalize
  • ends_with
  • join
  • js_replace
  • kebab_case
  • lines
  • quote
  • re_replace
  • replace
  • series_phrase
  • series_phrase_serial
  • starts_with
  • surround
• Reorder function arguments for after from (n, func) to (func, n). (breaking change)
• Reorder function arguments for before from (n, func) to (func, n). (breaking change)
• Reorder function arguments for times from (n, callback) to (callback, n). (breaking change)
• Reorder function arguments for js_match from (reg_exp, text) to (text, reg_exp). (breaking change)
• Reorder function arguments for js_replace from (reg_exp, text, repl) to (text, reg_exp, repl). (breaking change)

And some potential breaking changes:

• Move arrays.join to strings.join (possible breaking change).
• Rename join/implode‘s second parameter from delimiter to separator. (possible breaking change)
• Rename split/explode‘s second parameter from delimiter to separator. (possible breaking change)

Some notable new features/functions:

• 31 new string methods

  • pydash.strings.chars()
  • pydash.strings.chop()
  • pydash.strings.chop_right()
  • pydash.strings.class_case()
  • pydash.strings.clean()
  • pydash.strings.count_substr()
  • pydash.strings.decapitalize()
  • pydash.strings.has_substr()
  • pydash.strings.human_case()
  • pydash.strings.insert_substr()
  • pydash.strings.lines()
  • pydash.strings.number_format()
  • pydash.strings.pascal_case()
  • pydash.strings.predecessor()
  • pydash.strings.prune()
  • pydash.strings.re_replace()
  • pydash.strings.replace()
  • pydash.strings.separator_case()
  • pydash.strings.series_phrase()
  • pydash.strings.series_phrase_serial()
  • pydash.strings.slugify()
  • pydash.strings.split()
  • pydash.strings.strip_tags()
  • pydash.strings.substr_left()
  • pydash.strings.substr_left_end()
  • pydash.strings.substr_right()
  • pydash.strings.substr_right_end()
  • pydash.strings.successor()
  • pydash.strings.swap_case()
  • pydash.strings.title_case()
  • pydash.strings.unquote()

• 1 new array method

  • pydash.arrays.duplicates()

• 2 new function methods

  • pydash.functions.ary()
  • pydash.functions.rearg()

• 1 new collection method:

  • pydash.collections.sort_by_all()

• 4 new object methods

  • pydash.objects.to_boolean()
  • pydash.objects.to_dict()
  • pydash.objects.to_number()
  • pydash.objects.to_plain_object()

• 4 new predicate methods

  • pydash.predicates.is_blank()
  • pydash.predicates.is_builtin() and alias pydash.predicates.is_native()
  • pydash.predicates.is_match()
  • pydash.predicates.is_tuple()

• 1 new utility method

  • pydash.utilities.prop_of() and alias pydash.utilities.property_of()

• 6 new aliases:

  • pydash.predicates.is_bool() for pydash.predicates.is_boolean()
  • pydash.predicates.is_dict() for pydash.predicates.is_plain_object()
  • pydash.predicates.is_int() for pydash.predicates.is_integer()
  • pydash.predicates.is_num() for pydash.predicates.is_number()
  • pydash.strings.truncate() for pydash.strings.trunc()
  • pydash.strings.underscore_case() for pydash.strings.snake_case()

• Chaining can now accept the root value argument late.

• Chains can be re-used with differnt initial values via chain().plant.

• New chains can be created using the chain’s computed value as the new chain’s initial value via chain().commit.

• Support iteration over class instance properties for non-list, non-dict, and non-iterable objects.

>>> from pydash import py_

>>> square_sum = py_().power(2).sum()

>>> [square_sum([1, 2, 3]), square_sum([4, 5, 6]), square_sum([7, 8, 9])]
[14, 77, 194]

From v1.x.x to v2.0.0¶

There were several breaking and potentially breaking changes in v2.0.0:

• pydash.arrays.flatten() is now shallow by default. Previously, it was deep by default. For deep flattening, use either flatten(..., is_deep=True) or flatten_deep(...).
• pydash.predicates.is_number() now returns False for boolean True and False. Previously, it returned True.
• Internally, the files located in pydash.api were moved to pydash. If you imported from pydash.api.<module>, then it’s recommended to change your imports to pull from pydash.
• The function functions() was renamed to callables() to avoid ambiguities with the module functions.py.

Some notable new features:

• Callback functions no longer require the full call signature definition. See Callbacks for more details.
• A new “_” instance was added which supports both method chaining and module method calling. See py_ Instance for more details.