Summary

Limit cache location to be in memory or in a default location.

Review Request #6648 — Created Nov. 27, 2014 and submitted Dec. 2, 2014, 9:35 p.m.

Information

Owner

brennie

Repository

RBTools

Branch

master

Bugs

Depends On

Commit

d3a15bc...

Reviewers

Groups

rbtools, students

People

Description

The HTTP cache for the API now takes a parameter that determines if it

is created in memory (create_db_in_memory). This parameter replaces

the db_path parameter, which previously accepted the special value

':memory:' to create the SQLite database in memory. The new

parameter is more straightforward because caches will only ever be

required to be created at the default location (for normal operation)

or in memory (for unit testing).
The default API cache path is stored on the APICache class as the

CACHE_PATH constant, which can be used without instantiating the

class. Becuase the HTTP cache for the API is only ever stored in one

location on disk, it can be cleared (i.e., unlinked) without

instantiating the class to determine where it is located on disk. This

is important in the case where the cache exists but has become corrupt

and cannot be loaded (and so instantiation of the APICache class will

fail).

Testing Done

Unit tests pass.

Issues

Description	From	Last Updated
Generally, it's a bit nicer to do a 'if True, else' than a 'if not True, else', just to keep …	chipx86	Nov. 30, 2014, 10:17 p.m.
Given that this is done in both cases, can we just move this out of the conditional?	chipx86	Nov. 30, 2014, 10:30 p.m.

Tool: Pyflakes
Processed Files:
    rbtools/api/tests.py
    rbtools/api/cache.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/api/tests.py
    rbtools/api/cache.py

rbtools/api/cache.py (Diff revision 1)

Show all issues

Generally, it's a bit nicer to do a 'if True, else' than a 'if not True, else', just to keep logic simple. Can we change this and move the else body up to here?

Commit:

-	3ca83b0eebdb67e38823c7a7d641c02b99328036
+	aa7ca29db4d352e5e371a711c264c266e79ea0d3

Diff:

Revision 2 (+78 -62)

Show changes

	rbtools/api/cache.py
	rbtools/api/tests.py
	rbtools/utils/filesystem.py

Tool: PEP8 Style Checker
Processed Files:
    rbtools/api/tests.py
    rbtools/utils/filesystem.py
    rbtools/api/cache.py



Tool: Pyflakes
Processed Files:
    rbtools/api/tests.py
    rbtools/utils/filesystem.py
    rbtools/api/cache.py

Looks like you have bits of the TREES/ALIASES change in here.

rbtools/api/cache.py (Diff revision 2)

Show all issues

Given that this is done in both cases, can we just move this out of the conditional?

Commit:

-	aa7ca29db4d352e5e371a711c264c266e79ea0d3
+	d3a15bc104aa9761ea9bb8ffb97485e7717392c7

Diff:

Revision 3 (+57 -57)

Show changes

	rbtools/api/cache.py
	rbtools/api/tests.py

Tool: Pyflakes
Processed Files:
    rbtools/api/tests.py
    rbtools/api/cache.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/api/tests.py
    rbtools/api/cache.py

Summary:

-	Allow cache to be cleared without instantiating it.
+	Allow cache to be cleared without instantiating it. The cache can now only be created at the default location or in memory.

Description:

		The HTTP cache for the API now takes a parameter that determines if it
~		is created in memory (`create_db_in_memory`) instead of specifying the
~		special location `':memory:'` to the `db_path` parameter. The default
~		path is now stored on the class as the `CACHE_PATH` field. This allows
~		the cache path to be determined without it being instantiated.
	~	is created in memory (`create_db_in_memory`). This parameter replaces
	~	the `db_path` parameter, which previously accepted the special value
	~	`':memory:'` to create the SQLite database in memory. The new
	~	parameter is more straightforward because caches will only ever be
	+	required to be created at the default location (for normal operation)
	+	or in memory (for unit testing).
	+
	+	The default API cache path is stored on the `APICache` class as the
	+	`CACHE_PATH` constant, which can be used without instantiating the
	+	class. This allows the cache to be cleared if it exists and has
	+	become corrupt and cannot be loaded.

Commit summaries are limited to 79 characters.

Summary:

-	Allow cache to be cleared without instantiating it. The cache can now only be created at the default location or in memory.
+	Limit cache location to be in memory or in a default location.

Description:

		The HTTP cache for the API now takes a parameter that determines if it
		is created in memory (`create_db_in_memory`). This parameter replaces
		the `db_path` parameter, which previously accepted the special value
		`':memory:'` to create the SQLite database in memory. The new
		parameter is more straightforward because caches will only ever be
		required to be created at the default location (for normal operation)
		or in memory (for unit testing).

		The default API cache path is stored on the `APICache` class as the
		`CACHE_PATH` constant, which can be used without instantiating the
~		class. This allows the cache to be cleared if it exists and has
~		become corrupt and cannot be loaded.
	~	class. Becuase the HTTP cache for the API is only ever stored in one
	~	location on disk, it can be cleared (i.e., unlinked) without
	+	instantiating the class to determine where it is located on disk. This
	+	is important in the case where the cache exists but has become corrupt
	+	and cannot be loaded (and so instantiation of the APICache class will
	+	fail).

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (4dd199c)