Skip to content

Improve zip file example #1166

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve zip file example #1166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/src/examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ file = CSV.File(http_response)
## [Reading from a zip file](@id zip_example)

```julia
using ZipArchives, Mmap, CSV, DataFrames
using ZipArchives, CSV, DataFrames

a = DataFrame(a = 1:3)
CSV.write("a.csv", a)
Expand All @@ -122,10 +122,14 @@ ZipWriter("a2.zip") do z
end

# read file from zip archive
z = ZipReader(mmap(open("a.zip"))) # or "a2.zip"
z = ZipReader(read("a.zip")) # or "a2.zip"
# This `read` here buffers the archive into memory.
# Mmap.jl or the code in
# https://github.com/JuliaIO/ZipArchives.jl/blob/v2.5.1/test/test_file-array.jl#L66
# can be used if the archive is larger than memory.

# identify the right file in zip
a_copy = CSV.File(zip_openentry(z, "a.csv")) |> DataFrame
a_copy = CSV.File(zip_readentry(z, "a.csv")) |> DataFrame

a == a_copy
```
Expand Down
Loading