Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide complete API documentation coverage of scrapy.exporters #3973

Merged
merged 1 commit into from Aug 28, 2019

Conversation

Gallaecio
Copy link
Member

@Gallaecio Gallaecio commented Aug 22, 2019

No description provided.

@codecov
Copy link

@codecov codecov bot commented Aug 22, 2019

Codecov Report

Merging #3973 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3973   +/-   ##
=======================================
  Coverage   85.36%   85.36%           
=======================================
  Files         167      167           
  Lines        9705     9705           
  Branches     1454     1454           
=======================================
  Hits         8285     8285           
  Misses       1162     1162           
  Partials      258      258
Impacted Files Coverage Δ
scrapy/exporters.py 100% <ø> (ø) ⬆️

@@ -410,3 +416,8 @@ JsonLinesItemExporter
this exporter is well suited for serializing large amounts of data.

.. _JSONEncoder: https://docs.python.org/2/library/json.html#json.JSONEncoder

MarshalItemExporter
-------------------
Copy link
Member

@kmike kmike Aug 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should support MarshalItemExporter or deprecate it. Any idea, what is it for?

Copy link
Member Author

@Gallaecio Gallaecio Aug 26, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s use case must be the same as PickleItemExporter’s. It should perform much better than pickle as long as its drawback are acceptable for your use case.

As to whether or not to deprecate it, I don’t mind either way.

Note that although the class was not documented, the feed export that uses it is: https://docs.scrapy.org/en/latest/topics/feed-exports.html#marshal

@kmike
Copy link
Member

@kmike kmike commented Aug 28, 2019

Thanks for the explanation @Gallaecio!

@kmike kmike merged commit 93d4b0b into scrapy:master Aug 28, 2019
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants