Refactor: Improve logic for parsing google-Style docstrings

[isatyamks]

Thank you for contributing to LangChain!

• PR title: "package: description"
  • Where "package" is whichever of langchain, community, core, etc. is being modified. Use "docs: ..." for purely docs changes, "infra: ..." for CI changes.
  • Example: "community: add foobar LLM"

Description:
Improved the _parse_google_docstring function in langchain/core to support parsing multi-paragraph descriptions before the Args: section while maintaining compliance with Google-style docstring guidelines. This change ensures better handling of docstrings with detailed function descriptions.

Issue:
Fixes #28628

Dependencies:
None.

Twitter handle:
@isatyamks

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
langchain	⬜️ Ignored (Inspect)	Visit Preview		Dec 18, 2024 5:55am

[efriis]

could you add some unit tests on cases that currently fail?

[isatyamks]

could you add some unit tests on cases that currently fail?

Hi @ccurme,Thank you for the feedback! I’m not very familiar with writing unit tests for this type of case. Could you please guide me.

[efriis]

you can add some tests to libs/core/tests/unit_tests/utils/test_function_calling.py that call _parse_google_docstring that fail in the current version of langchain but this PR fixes. i'm curious what this actually fixes because there are a bunch of docstrings that are parsed correctly that have multiple paragraphs e.g. https://python.langchain.com/api_reference/openai/chat_models/langchain_openai.chat_models.azure.AzureChatOpenAI.html

and I'm curious what this aims to fix. If you can do it before the holidays let me know! Otherwise we can close this one and reopen with tests whenever you have time to do so!

[isatyamks]

@efriis I’ve added tests to validate the updated _parse_google_docstring function, but some checks are failing. Could you help identify what’s going wrong?

[efriis]

fixed the lint errors but the tests you added are failing. You can run them locally with

cd libs/core
poetry install --with lint,typing,test --sync
make test

and for future reference you can run format/lint (what i fixed) with:

cd libs/core
poetry install --with lint,typing,test --sync
make format lint

[isatyamks]

fixed the lint errors but the tests you added are failing. You can run them locally with

cd libs/core
poetry install --with lint,typing,test --sync
make test

and for future reference you can run format/lint (what i fixed) with:

cd libs/core
poetry install --with lint,typing,test --sync
make format lint

Thanks for the help! I now have a better understanding of how to do it.

[isatyamks]

@efriis, I believe all tests have now passed. Huge thanks to you and @ccurme for your help!