Pydash

-------------------

New Features
++++++++++++

- Make ``property_`` work with deep path strings.

Bug Fixes
+++++++++

- Revert removal of ``deep_pluck`` and rename to ``pluck``. Previously, ``deep_pluck`` was removed and ``map_`` was recommended as a replacement. However, ``deep_pluck`` (now defined as ``pluck``) functionality is not supported by ``map_`` so the removal ``pluck`` was reverted.

Backwards-Incompatibilities
+++++++++++++++++++++++++++

- Remove ``property_deep`` (use ``property_``).


.. _changelog-v4.0.0:

-------------------

New Features
++++++++++++

- Add ``assign_with``.
- Add ``clamp``.
- Add ``clone_deep_with``.
- Add ``clone_with``.
- Add ``cond``. Thanks bharadwajyarlagadda_!
- Add ``conforms``.
- Add ``conforms_to``.
- Add ``default_to``. Thanks bharadwajyarlagadda_!
- Add ``difference_by``.
- Add ``difference_with``.
- Add ``divide``. Thanks bharadwajyarlagadda_!
- Add ``eq``. Thanks bharadwajyarlagadda_!
- Add ``flat_map``.
- Add ``flat_map_deep``.
- Add ``flat_map_depth``.
- Add ``flatten_depth``.
- Add ``flip``. Thanks bharadwajyarlagadda_!
- Add ``from_pairs``. Thanks bharadwajyarlagadda_!
- Add ``intersection_by``.
- Add ``intersection_with``.
- Add ``invert_by``.
- Add ``invoke_map``.
- Add ``is_equal_with``. Thanks bharadwajyarlagadda_!
- Add ``is_match_with``.
- Add ``is_set``. Thanks bharadwajyarlagadda_!
- Add ``lower_case``. Thanks bharadwajyarlagadda_!
- Add ``lower_first``. Thanks bharadwajyarlagadda_!
- Add ``max_by``.
- Add ``mean_by``.
- Add ``merge_with``.
- Add ``min_by``.
- Add ``multiply``. Thanks bharadwajyarlagadda_!
- Add ``nth``. Thanks bharadwajyarlagadda_!
- Add ``nth_arg``. Thanks bharadwajyarlagadda_!
- Add ``omit_by``.
- Add ``over``. Thanks bharadwajyarlagadda_!
- Add ``over_every``. Thanks bharadwajyarlagadda_!
- Add ``over_some``. Thanks bharadwajyarlagadda_!
- Add ``pick_by``.
- Add ``pull_all``. Thanks bharadwajyarlagadda_!
- Add ``pull_all_by``.
- Add ``pull_all_with``.
- Add ``range_right``. Thanks bharadwajyarlagadda_!
- Add ``sample_size``. Thanks bharadwajyarlagadda_!
- Add ``set_with``.
- Add ``sorted_index_by``.
- Add ``sorted_index_of``. Thanks bharadwajyarlagadda_!
- Add ``sorted_last_index_by``.
- Add ``sorted_last_index_of``.
- Add ``sorted_uniq``. Thanks bharadwajyarlagadda_!
- Add ``sorted_uniq_by``.
- Add ``stub_list``. Thanks bharadwajyarlagadda_!
- Add ``stub_dict``. Thanks bharadwajyarlagadda_!
- Add ``stub_false``. Thanks bharadwajyarlagadda_!
- Add ``stub_string``. Thanks bharadwajyarlagadda_!
- Add ``stub_true``. Thanks bharadwajyarlagadda_!
- Add ``subtract``. Thanks bharadwajyarlagadda_!
- Add ``sum_by``.
- Add ``to_integer``.
- Add ``to_lower``. Thanks bharadwajyarlagadda_!
- Add ``to_path``. Thanks bharadwajyarlagadda_!
- Add ``to_upper``. Thanks bharadwajyarlagadda_!
- Add ``unary``.
- Add ``union_by``. Thanks bharadwajyarlagadda_!
- Add ``union_with``. Thanks bharadwajyarlagadda_!
- Add ``uniq_by``.
- Add ``uniq_with``.
- Add ``unset``.
- Add ``update``.
- Add ``update_with``.
- Add ``upper_case``. Thanks bharadwajyarlagadda_!
- Add ``upper_first``. Thanks bharadwajyarlagadda_!
- Add ``xor_by``.
- Add ``xor_with``.
- Add ``zip_object_deep``.
- Make function returned by ``constant`` ignore extra arguments when called.
- Make ``get`` support attribute access within path.
- Make ``iteratee`` treat an integer argument as a string path (i.e. ``iteratee(1)`` is equivalent to ``iteratee('1')`` for creating a path accessor function).
- Make ``intersection`` work with unhashable types.
- Make ``range_`` support decrementing when ``start`` argument is greater than ``stop`` argument.
- Make ``xor`` maintain sort order of supplied arguments.

Bug Fixes
+++++++++

- Fix ``find_last_key`` so that it iterates over object in reverse.

Backwards-Incompatibilities
+++++++++++++++++++++++++++

- Make ``add`` only support two argument addition. (**breaking change**)
- Make ``difference`` return duplicate values from first argument and maintain sort order. (**breaking change**)
- Make ``invoke`` work on objects instead of collections. Use ``invoke_map`` for collections. (**breaking change**)
- Make ``set_`` support mixed ``list``/``dict`` defaults within a single object based on whether key or index path substrings used. (**breaking change**)
- Make ``set_`` modify object in place. (**breaking change**)
- Only use ``merge`` callback result if result is not ``None``. Previously, result from callback (if provided) was used unconditionally. (**breaking change**)
- Remove functions: (**breaking change**)

- ``deep_pluck`` (no alternative) [**UPDATE:** ``deep_pluck`` functionality restored as ``pluck`` in ``v4.0.1``]
- ``mapiter`` (no alternative)
- ``pluck`` (use ``map_``)
- ``update_path`` (use ``update`` or ``update_with``)
- ``set_path`` (use ``set_`` or ``set_with``)

- Remove aliases: (**breaking change**)

- ``all_`` (use ``every``)
- ``any_`` (use ``some``)
- ``append`` (use ``push``)
- ``average`` and ``avg`` (use ``mean`` or ``mean_by``)
- ``callback`` (use ``iteratee``)
- ``cat`` (use ``concat``)
- ``collect`` (use ``map_``)
- ``contains`` (use ``includes``)
- ``curve`` (use ``round_``)
- ``deep_get`` and ``get_path`` (use ``get``)
- ``deep_has`` and ``has_path`` (use ``has``)
- ``deep_prop`` (use ``property_deep``)
- ``deep_set`` (use ``set_``)
- ``detect`` and ``find_where`` (use ``find``)
- ``each`` (use ``for_each``)
- ``each_right`` (use ``for_each_right``)
- ``escape_re`` (use ``escape_reg_exp``)
- ``explode`` (use ``split``)
- ``extend`` (use ``assign``)
- ``first`` (use ``head``)
- ``foldl`` (use ``reduce``)
- ``foldr`` (use ``reduce_right``)
- ``for_own`` (use ``for_each``)
- ``for_own_right`` (use ``for_each_right``)
- ``implode`` (use ``join``)
- ``is_bool`` (use ``is_boolean``)
- ``is_int`` (use ``is_integer``)
- ``is_native`` (use ``is_builtin``)
- ``is_num`` (use ``is_number``)
- ``is_plain_object`` (use ``is_dict``)
- ``is_re`` (use ``is_reg_exp``)
- ``js_match`` (use ``reg_exp_js_match``)
- ``js_replace`` (use ``reg_exp_js_replace``)
- ``keys_in`` (use ``keys``)
- ``moving_average`` and ``moving_avg`` (use ``moving_mean``)
- ``object_`` (use ``zip_object``)
- ``pad_left`` (use ``pad_start``)
- ``pad_right`` (use ``pad_end``)
- ``pipe`` (use ``flow``)
- ``pipe_right`` and ``compose`` (use ``flow_right``)
- ``prop`` (use ``property_``)
- ``prop_of`` (use ``property_of``)
- ``pow_`` (use ``power``)
- ``re_replace`` (use ``reg_exp_replace``)
- ``rest`` (use ``tail``)
- ``select`` (use ``filter_``)
- ``sigma`` (use ``std_deviation``)
- ``sort_by_all`` and ``sort_by_order`` (use ``order_by``)
- ``trim_left`` (use ``trim_start``)
- ``trim_right`` (use ``trim_right``)
- ``trunc`` (use ``truncate``)
- ``underscore_case`` (use ``snake_case``)
- ``unique`` (use ``uniq``)
- ``values_in`` (use ``values``)
- ``where`` (use ``filter_``)

- Rename functions: (**breaking change**)

- ``deep_map_values`` to ``map_values_deep``
- ``deep_property`` to ``property_deep``
- ``include`` to ``includes``
- ``index_by`` to ``key_by``
- ``mod_args`` to ``over_args``
- ``moving_average`` to ``moving_mean``
- ``pairs`` to ``to_pairs``

- Remove ``callback`` argument from: (**breaking change**)

- ``assign``. Moved to ``assign_with``.
- ``clone`` and ``clone_deep``. Moved to ``clone_with`` and ``clone_deep_with``.
- ``is_match``. Moved to ``is_match_with``.
- ``max_`` and ``min_``. Moved to ``max_by`` and ``min_by``.
- ``omit``. Moved to ``omit_by``.
- ``pick``. Moved to ``pick_by``.
- ``sorted_index``. Moved to ``sorted_index_by``.
- ``sum_``. Moved to ``sum_by``.
- ``uniq``/``unique``. Moved to ``uniq_by``.

- Renamed ``callback`` argument to ``predicate``: (**breaking change**)

- ``drop_right_while``
- ``drop_while``
- ``every``
- ``filter_``
- ``find``
- ``find_key``
- ``find_last``
- ``find_index``
- ``find_last_index``
- ``find_last_key``
- ``partition``
- ``reject``
- ``remove``
- ``some``
- ``take_right_while``
- ``take_while``

- Renamed ``callback`` argument to ``iteratee``: (**breaking change**)

- ``count_by``
- ``duplicates``
- ``for_each``
- ``for_each_right``
- ``for_in``
- ``for_in_right``
- ``group_by``
- ``key_by``
- ``map_``
- ``map_keys``
- ``map_values``
- ``map_values_deep``
- ``mapcat``
- ``median``
- ``reduce_``
- ``reduce_right``
- ``reductions``
- ``reductions_right``
- ``sort_by``
- ``times``
- ``transform``
- ``unzip_with``
- ``zip_with``
- ``zscore``

- Rename ``comparison`` argument in ``sort`` to ``comparator``.
- Rename ``index`` and ``how_many`` arguments in ``splice`` to ``start`` and ``count``.
- Remove ``multivalue`` argument from ``invert``. Feature moved to ``invert_by``. (**breaking change**)

-------------------

- Make internal function inspection methods work with Python 3 annotations. Thanks tgriesser_!

-------------------

- Fix bug in ``get`` where an iterable default was iterated over instead of being returned when an object path wasn't found. Thanks urbnjamesmi1_!

-------------------

- Fix bug in ``get`` where casting a string key to integer resulted in an uncaught exception instead of the default value being returned instead. Thanks urbnjamesmi1_!

-------------------

- Add optional ``default`` parameter to ``min_`` and ``max_`` functions that is used when provided iterable is empty.
- Fix bug in ``is_match`` where comparison between an empty ``source`` argument returned ``None`` instead of ``True``.